Reply to Hedge on a submission (answer, revise, authorize a bind)

POST

/broker/submissions/{submission_id}/thread

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

• Production
• Staging sandbox

Identical in effect to replying to Hedge’s email. Use it to answer a question Hedge asked, send a revision, attach documents you already uploaded, or give a bind authorization (“bind the Kinsale quote, effective 10/1”). Your message is recorded on the thread and Hedge’s quarterback answers on the same submission; the answer arrives in the thread and on the submission.message webhook, typically within a couple of minutes. Requires the broker_submit scope. Machine credentials must name producer_email.

Send an Idempotency-Key header (up to 128 characters, unique per message) so a retried request attaches to the same turn instead of sending your message twice.

Authorizations

• brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

Header Parameters

Idempotency-Key

string

<= 128 characters

Client-generated key; a retry with the same key replays or attaches to the original turn.

Request Body^required

Media typeapplication/json

object

body

required

Your reply to Hedge, plain text. Written exactly as you would reply to Hedge’s email.

string

>= 1 characters <= 20000 characters

document_ids

Ids of documents you already uploaded to this submission (POST .../documents) to attach to the reply. Every id must belong to this submission (400 otherwise).

Array<string>

<= 10 items

producer_email

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

string

Example^generated

{
  "body": "example",
  "document_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "producer_email": "example"
}

Responses

202

Received; Hedge is answering asynchronously.

Media typeapplication/json

object

message_id

required

The thread id of your message (readable via GET .../thread).

string format: uuid

status

required

string

Allowed value: received

detail

required

string

Example

{
  "status": "received"
}

400

A document id does not belong to this submission

403

Token lacks the broker_submit scope

404

Not found (or not your brokerage’s)

422

Blank body