Skip to main content
POST
/
api
/
broker_submissions
Create broker submission
curl --request POST \
  --url https://app.herondata.io/api/broker_submissions/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "heron_id": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

The name of the submission being made, this is purely for user reference.

Minimum string length: 10

Response

200 - application/json

OK

heron_id
string

Heron ID of the created submission