Zernio
Zernio
API Reference

Sequences

List enrollments for a sequenceGETList sequencesGETCreate sequencePOSTGet sequence with stepsGETUpdate sequencePATCHDelete sequenceDELETEActivate sequencePOSTEnroll contacts in a sequencePOSTPause sequencePOSTUnenroll contactDELETE
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Sequences

Enroll contacts in a sequence

Enroll one or more contacts into a sequence. Contacts already enrolled are skipped.

POST
/v1/sequences/{sequenceId}/enroll

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

sequenceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

{  "success": true,  "enrolled": 0,  "failed": 0,  "results": [    {      "contactId": "string",      "success": true,      "error": "string"    }  ]}
Was this page helpful?

Activate sequence

Start a draft or paused sequence. The sequence must have at least one step.

Pause sequence

Pause an active sequence. Enrolled contacts stop receiving messages until the sequence is reactivated.

contactIds*array<string>
channelIds?array<string>

Optional. Auto-detected if not provided.