HEhedgespecialty
Submissions

Withdraw a submission (pull the risk from marketing)

Changed on

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.

post/broker/submissions/{submission_id}/withdraw

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Path parameters

submission_idstring uuid required

Request body

producer_emailstring

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

Response

Accepted

outcome'discarded' | 'withdrawal_requested' | 'already_closed'
detailstring

Changes