How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Syllable Outbound.batches API

Operations related to outbound campaign batches

Syllable Outbound.batches API is one of 41 APIs that Syllable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 6 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 0.0.3.

Requests are made against a single base URL, https://api.syllable.cloud.

9 operations 6 paths 16 schemas 1 DELETE3 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.3
Base URL
https://api.syllable.cloud
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Syllable Outbound.batches API declares 1 security scheme for authenticating requests. An API key is passed in the header as Syllable-API-Key (APIKeyHeader).

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

outbound.batches 9

Operations related to outbound campaign batches

GET
/api/v1/outbound/batches
List Outbound Communication Batches
outbound_batch_list 9 params → 200422
POST
/api/v1/outbound/batches
Create Outbound Communication Batch
outbound_batch_create body → 200422
GET
/api/v1/outbound/batches/{batch_id}
Get Outbound Communication Batch
outbound_batch_get_by_id 1 param → 200422
PUT
/api/v1/outbound/batches/{batch_id}
Update Outbound Communication Batch
outbound_batch_update 1 param body → 200422
DELETE
/api/v1/outbound/batches/{batch_id}
Delete Outbound Communication Batch
outbound_batch_delete 1 param body → 200422
POST
/api/v1/outbound/batches/{batch_id}/upload_batch
Upload Outbound Communication Batch
outbound_batch_upload 1 param body → 200422
GET
/api/v1/outbound/batches/{batch_id}/results
Fetch Outbound Communication Batch Results
outbound_batch_results 4 params → 200422
POST
/api/v1/outbound/batches/{batch_id}/requests
Create Outbound Communication Request
outbound_batch_add 1 param body → 200422
POST
/api/v1/outbound/batches/{batch_id}/remove-requests
Delete Requests By List Of Reference Ids
outbound_batch_remove 1 param body → 200422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CommunicationRequestResult (15 properties), BatchDetails (15 properties), CommunicationBatch (13 properties), ListResponse_CommunicationBatch_ (5 properties). Each schema is shown below with its type and property counts.

CommunicationBatchInput
object
4 properties 2 required
ListResponse_CommunicationBatch_
object
5 properties 3 required
OrderByDirection
string
The direction in which to order list results, either ascending or descending.
BatchProperties
string
HTTPValidationError
object
1 property
CommunicationBatchUpdate
object
2 properties
Body_outbound_batch_delete
object
1 property 1 required
CommunicationRequest
object
3 properties 3 required
CommunicationRequestResult
object
15 properties 3 required
ValidationError
object
3 properties 3 required
BatchDetails
object
15 properties 3 required
BatchStatus
string
Status of a communication batch.
Body_outbound_batch_upload
object
1 property
RequestStatusBreakdown
object
Per-requeststatus breakdown with total count and optional channelmanagerstatus counts.
2 properties 1 required
CommunicationBatch
object
13 properties 3 required
RequestStatus
string
Status of a communication request.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

syllable-outbound-batches-api-openapi.yml Raw ↑

Other APIs Syllable publishes across the network.

Syllable Agents API
Syllable Agents.test API
Syllable Bridge Phrases API
Syllable Channels API
Syllable Channels.targets API
Syllable Channels.twilio API
Syllable Channels.twilio.numbers API
Syllable Conversation Config API
Syllable Conversations API
Syllable Custom Messages API
Syllable Dashboards API
Syllable Data Sources API
Where this information came from

This is an independent, third-party profile of Syllable Outbound.batches API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.