Skip to main content
POST
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
/
requests
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.outbound.batches.add({
    batchId: "<id>",
    communicationRequest: {
      referenceId: "12345",
      target: "512-555-1234",
      requestVariables: {

      },
    },
  });

  console.log(result);
}

run();
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

batch_id
string
required

Body

application/json
reference_id
string
required

ID for target outreach (unique within batch)

Example:

"12345"

target
string
required

Target phone number

Examples:

"512-555-1234"

"+15125551234"

request_variables
Request Variables · object
required

Variables for request

Response

Successful Response