Skip to main content
POST
/
outreach-sequences
/
{id}
/
runs
Enroll a recipient in an outreach sequence
curl --request POST \
  --url https://api.gospott.com/outreach-sequences/{id}/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "run": {
    "candidateId": "<string>",
    "type": "candidate"
  }
}
'
{
  "id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

​
id
string
required

Body

application/json
​
run
object
required

The recipient to enroll.

Response

Recipient enrolled successfully. Returns the run ID.

​
id
string
required
Minimum string length: 1