Pular para o conteúdo

GET /v1/campaigns/broadcast-readiness

GET
/v1/campaigns/broadcast-readiness
curl --request GET \
--url https://seu-endereco-da-api/v1/campaigns/broadcast-readiness \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler campanhas (campaigns:read).

Media typeapplication/json
object
email
required

Module on and at least one connected sender in a verified domain

boolean
sms
required

Module on and a connected SMS channel

boolean
emailSenders
required

Senders a campaign can use, so campaigns:read is enough to build one

Array<object>
object
id
required
string
channelId
required
string
fromEmail
required
string
fromName
required
string
smsChannelId
required

Channel a SMS campaign is sent through

string
nullable

Example generated

{
"email": true,
"sms": true,
"emailSenders": [
{
"id": "example",
"channelId": "example",
"fromEmail": "example",
"fromName": "example"
}
],
"smsChannelId": "example"
}