Surge home page
SupportDashboard
Surge

Create blast

POST
/accounts/{account_id}/blasts

Sends a Blast.

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

account_id*string

The account for which the blast should be sent.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

import Surge from '@surgeapi/node';

const client = new Surge({
  apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});

const blast = await client.blasts.create('acct_01j9a43avnfqzbjfch6pygv1td');

console.log(blast.id);
{
  "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"
}
{
  "error": {
    "message": "The requested resource could not be found.",
    "type": "not_found"
  }
}