API Reference
API Reference

Create Outbound Communication Request

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

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

batch_id string path required

Request body

application/json

body CommunicationRequest required
3 fields
reference_idstringrequired

ID for target outreach (unique within batch)

targetstringrequired

Target phone number

request_variablesobjectrequired

Variables for request

1 field
{key}stringoptional
Request example
{
  "reference_id": "string",
  "target": "string",
  "request_variables": "string"
}

Responses

200Successful Response

application/json

response unspecified required
Response example
string
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}