Skip to main content
POST
outreach.broadcast.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

A connected messaging account, from social.accounts.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
name
string
required

Name of the broadcast, for your own reference.

Required string length: 1 - 256
text
string
required

The message text, up to 4096 characters.

Required string length: 1 - 4096
description
string

Note about the broadcast, for your own reference.

Required string length: 1 - 1000
contactIds
string[]

Contacts to add as recipients, from outreach.contacts.list. Up to 1000.

Required array length: 1 - 1000 elements
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

broadcastId
string
required

Pass to outreach.broadcast.send.

status
string
required

Always draft: nothing is sent yet.

Allowed value: "draft"
recipientsAdded
number

Recipients added.

recipientsSkipped
number

Recipients skipped, for example opted out.