POST /v1/group-launches/{id}/broadcasts
POST
/v1/group-launches/{id}/broadcasts
const url = 'https://seu-endereco-da-api/v1/group-launches/example/broadcasts';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"steps":[{}],"gapMin":1,"gapMax":1,"scheduledAt":"example","groupIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'};
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/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).
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
steps
required
Array<object>
object
gapMin
required
number
gapMax
required
number
scheduledAt
string
groupIds
Array<string>
Example generated
{ "steps": [ {} ], "gapMin": 1, "gapMax": 1, "scheduledAt": "example", "groupIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ]}Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
status
required
string
total
required
number
sent
required
number
failed
required
number
failureReason
required
string
scheduledAt
required
string
gapMin
required
number
gapMax
required
number
steps
required
Array<object>
object
kind
required
string
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