POST /v1/campaigns/broadcast-estimate
POST
/v1/campaigns/broadcast-estimate
const url = 'https://seu-endereco-da-api/v1/campaigns/broadcast-estimate';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"kind":"email","audienceFilter":{},"segmentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","smsBody":"example"}'};
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/campaigns/broadcast-estimate \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "kind": "email", "audienceFilter": {}, "segmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "smsBody": "example" }'Permissão que a Chave de acesso precisa: Ler campanhas (campaigns:read).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
kind
required
string
audienceFilter
object
key
additional properties
any
segmentId
string format: uuid
smsBody
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
kind
required
string
eligible
required
number
excluded
required
object
noAddress
required
Contacts without a valid address for the kind
number
suppressed
required
Contacts that unsubscribed, bounced, reported spam or are blacklisted
number
blocked
required
number
duplicate
required
Contacts that share an address with another contact already in the audience
number
unitsPerRecipient
required
1 for e-mail; sms segments of the text, counting each variable at a conservative width
number
unitPriceMicros
required
Null while no price is published
number
totalMicros
required
number
balanceMicros
required
number
missingMicros
required
number
covered
required
True when the balance covers the whole audience
boolean
Example
{ "kind": "email"}