POST /v1/sequences/{id}/enroll
POST
/v1/sequences/{id}/enroll
const url = 'https://seu-endereco-da-api/v1/sequences/example/enroll';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"contactId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","segmentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","audienceFilter":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/sequences/example/enroll \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "contactId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "segmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "audienceFilter": {} }'Permissão que a Chave de acesso precisa: Gerenciar sequências (sequences:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
contactId
string format: uuid
segmentId
string format: uuid
audienceFilter
object
key
additional properties
any
Example generated
{ "contactId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "segmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "audienceFilter": {}}Responses
Seção intitulada “Responses”Media typeapplication/json
object
enrolled
required
Enrolled synchronously; always 0 for an audienceFilter request
number
skipped
required
Skipped synchronously; always 0 for an audienceFilter request
number
queued
required
True when the audience fan-out was handed to the flow-engine instead of running inline
boolean
requestId
required
Identifier of the queued fan-out request
string
Example generated
{ "enrolled": 1, "skipped": 1, "queued": true, "requestId": "example"}