Enroll a store into a cadence

POST/cadences/{id}/enrollmentsPilot

This operation is available only to approved Outreach Studio pilot workspaces.

Sends route from the key creator's own connected Google mailbox. An agency-scoped key with no owning user cannot send and returns a 422 no-own-mailbox error.

Requires scope: write:outreach

Parameters

Parameter	In	Type	Description
`id`required	path	string	Cadence id
`Idempotency-Key`required	header	string	Stable caller request ID. Required so retries never request or spend for a second report.

Request body

Field	Type	Allowed values	Description
`store_id`required	string	any string
`contact_id`	string	any string	Optional; the best contact with confirmed recipient permission is chosen otherwise

Responses

Status	Description
`200`	Enrolled
`401`	Missing or invalid API key
`403`	Key lacks the required scope
`409`	Already in a cadence / not enrollable
`422`	No usable contact for the store
`429`	Rate limit exceeded (see Retry-After)

Is this page helpful?

Request

curl -X POST "https://vergio.ai/api/v1/cadences/b7c9a2e1-0000-4000-8000-000000000000/enrollments" \
  -H "Authorization: Bearer $VERGIO_API_KEY" \
  -H "Idempotency-Key: replace-with-a-stable-request-id" \
  -H "Content-Type: application/json" \
  -d '{
  "store_id": "b7c9a2e1-0000-4000-8000-000000000000",
  "contact_id": "b7c9a2e1-0000-4000-8000-000000000000"
}'

Response (200)

{
  "ok": true,
  "enrolled": 0,
  "earliest_next_send_at": "string"
}