Pular para o conteúdo

POST /v1/sequences/{id}/enroll

POST
/v1/sequences/{id}/enroll
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).

id
required
string
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": {}
}
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
nullable

Example generated

{
"enrolled": 1,
"skipped": 1,
"queued": true,
"requestId": "example"
}