SUsurgeapi
Blasts

Send a blast

Changed on

Sends a Blast.

post/accounts/{account_id}/blasts

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/accounts/{account_id}/blasts
  • Auth
    HTTP bearer

Path parameters

account_idstring required

The account for which the blast should be sent.

Example:acct_01j9a43avnfqzbjfch6pygv1td

Request body

bodystring nullable

The message body.

contactsstring[]

Deprecated. Use to instead.

fromstring

The phone number from which to send the blast. This can be either the phone number in E.164 format or a Surge phone number id. If not provided, the account's default phone number is used.

namestring

Optional name for the blast.

segmentsstring[]

Deprecated. Use to with audience IDs instead.

send_atstring date-time

When to send the blast. If not provided, sends immediately.

Example request

{
  "attachments": [
    {
      "url": "https://example.com/image.jpg"
    }
  ],
  "body": "Join us for our grand opening!",
  "from": "+18015552345",
  "name": "Grand Opening Announcement",
  "send_at": "2024-02-01T15:00:00Z",
  "to": [
    "aud_01j9dy8mdzfn3r0e8x1tbdrdrf",
    "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
    "+18015551234",
    "+18015555678"
  ]
}

Response

Created blast

bodystring nullable

The message body.

idstring

Unique identifier for the object.

namestring

Optional name for the blast.

send_atstring date-time

When the blast will be or was sent.

Example response

{
  "attachments": [
    {
      "url": "https://example.com/image.jpg"
    }
  ],
  "body": "Join us for our grand opening!",
  "id": "bst_01j9dy8mdzfn3r0e8x1tbdrdrf",
  "name": "Grand Opening Announcement",
  "send_at": "2024-02-01T15:00:00Z"
}

Changes