Pular para o conteúdo

POST /v1/group-launches/{id}/broadcasts

POST
/v1/group-launches/{id}/broadcasts
curl --request POST \
--url https://seu-endereco-da-api/v1/group-launches/example/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "steps": [ {} ], "gapMin": 1, "gapMax": 1, "scheduledAt": "example", "groupIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Permissão que a Chave de acesso precisa: Gerenciar grupos de lançamento (group-launches:manage).

id
required
string
Media typeapplication/json
object
steps
required
Array<object>
object
gapMin
required
number
<= 3600
gapMax
required
number
<= 3600
scheduledAt
string
groupIds
Array<string>
>= 1 items

Example generated

{
"steps": [
{}
],
"gapMin": 1,
"gapMax": 1,
"scheduledAt": "example",
"groupIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
]
}
Media typeapplication/json
object
id
required
string
status
required
string
Allowed values: scheduled sending done cancelled failed
total
required
number
sent
required
number
failed
required
number
failureReason
required
string
nullable
scheduledAt
required
string
gapMin
required
number
gapMax
required
number
steps
required
Array<object>
object
kind
required
string
Allowed values: text image document
text
string
mediaKey
string
mediaMime
string
fileName
string
createdAt
required
string

Example

{
"status": "scheduled",
"steps": [
{
"kind": "text"
}
]
}

Invalid steps, or no group can receive the broadcast