Withdraw a submission (pull the risk from marketing)

POST

/broker/submissions/{submission_id}/withdraw

curl --request POST \
  --url https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "producer_email": "example" }'

• Production
• Staging sandbox

Branches on placement state: an unfinalized draft is deleted on the spot; a live placement becomes a withdrawal Hedge carries out (notices to every engaged market, then the submission closes as withdrawn); a submission with a bound policy cannot be withdrawn here (409; request a change on the policy instead). Idempotent. Requires the broker_submit scope. Machine credentials must name producer_email in the body; per-user tokens send no body.

Authorizations

• brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

Request Body

Media typeapplication/json

object

producer_email

REQUIRED when authenticating with a machine credential; the active portal user the withdrawal is attributed to.

string

Example^generated

{
  "producer_email": "example"
}

Responses

202

Accepted

Media typeapplication/json

object

outcome

string

Allowed values: discarded withdrawal_requested already_closed

detail

string

Example

{
  "outcome": "discarded"
}

403

Token lacks the broker_submit scope

404

Not found (or not your brokerage’s)

409

Bound policy (use a policy change request)

422

Missing/unknown producer_email for a machine credential

503

The withdrawal could not be started; retry