Create Outbound Communication Request

POST /api/v1/outbound/batches/{batch_id}/requests

Python (SDK)

Python

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.outbound.batches.add(batch_id="<id>", communication_request={
        "reference_id": "12345",
        "target": "512-555-1234",
        "request_variables": {

        },
    })

    # Handle response
    print(res)

422

{
  "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"

"[phone]"

request_variables · Request Variables · object · required

Variables for request

Show child attributes

Response

200

application/json

Successful Response