Sequences

List and enroll. Owner required, DNC and already-active fail closed.

Official Aivyro contentAligned with the current public contract

POST/api/v1/sequences/{id}/enrollments

List { "data": [ … ] }. Archived sequences omitted. Enroll the same way the product does: owner required, do-not-contact fails closed, already-active is not a new enrollment. 201 when created. 200 with enrolled: false when ineligible or already active.

HTTP	Path	Scope
GET	`/api/v1/sequences`	`rest.sequences.read`
GET	`/api/v1/sequences/{id}`	`rest.sequences.read`
GET	`/api/v1/sequences/{id}/enrollments`	`rest.sequences.read`
GET	`/api/v1/sequences/{id}/performance`	`rest.sequences.read`
POST	`/api/v1/sequences/{id}/enrollments`	`rest.sequences.write`

Fields

Field	Type	Notes
id	UUID	Sequence id.
name / description	string	Public metadata.
status	string	Archived sequences are omitted.
contact_id	UUID	Enroll body.
enrolled	boolean	201 true. 200 false if ineligible or already active.

POST /api/v1/sequences/{id}/enrollments

curl -sS -X POST "$AIVYRO_API_BASE/api/v1/sequences/$SEQUENCE_ID/enrollments" \
  -H "Authorization: Bearer $AIVYRO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"'"$CONTACT_ID"'"}'