Skip to main content
Send Broadcast Message
curl --request POST \
  --url https://integration.getmateo.com/api/v1/send_broadcast \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attachment": "<string>",
  "require_marketing_opt_in": true,
  "to_recipients": [
    {
      "contact_id": "<string>",
      "full_name": "<string>",
      "handle": "<string>",
      "placeholder_values": [
        "<string>"
      ],
      "contact_external_id": "<string>",
      "contact_secondary_external_id": "<string>"
    }
  ],
  "to_segments": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "send_after": "2023-11-07T05:31:56Z",
  "placeholder_values": [
    "<string>"
  ],
  "marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "review_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "sendout_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
from
string<uuid>
required

The channel the broadcast is sent from

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
template_id
string<uuid>
required

The template to use for the broadcast

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
attachment
string | null

Attachment URL. Can either https:// or media_library://

​
require_marketing_opt_in
boolean
default:true

Whether the recipients must have opted in to marketing messages

​
to_recipients
object[] | null

The list of recipients to send the broadcast to

​
to_segments
string<uuid>[] | null

The list of segments to send the broadcast to

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
send_after
string<date-time> | null

The time to send the broadcast after

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
​
placeholder_values
string[] | null

Placeholder values

​
marketing_channel_id
string<uuid> | null

Marketing Channel ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
review_channel_id
string<uuid> | null

Review Channel ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

The broadcast was sent successfully

​
sendout_id
string<uuid>
required

The ID of the sendout that has been sent

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$