POST
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
/
requests
curl --request POST \
  --url https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}/requests \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '{
  "batch_id": "20250117.9",
  "reference_id": "12345",
  "target": "user@email.com",
  "request_status": "PENDING",
  "request_variables": {}
}'
"<any>"

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
batch_id
string
required

Body

application/json
​
batch_id
string
required

Unique ID for conversation batch

Example:

"20250117.9"

​
reference_id
string
required

ID for target outreach (unique within batch)

Example:

"12345"

​
target
string
required

Target phone number or email address

Example:

"user@email.com"

​
request_variables
object
required

Variables for request

​
request_status
enum<string>

Status of request

Available options:
PENDING,
QUEUEING,
INITIATED,
CONNECTED,
FAILED,
CANCELED

Response

200
application/json
Successful Response

The response is of type any.