Deployments.ai Docs
Runtime

Compose an outbound channel delivery

POST /v1/channel-bindings/{bindingId}/deliveries · SDK composeChannelDelivery · CLI deployments channel-binding deliver

POST
/v1/channel-bindings/{bindingId}/deliveries

Requires channels:write.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

bindingId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string

Must contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.

Match^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$
Length1 <= length <= 256

Request Body

application/json
  1. body
content*string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 40000
externalChannelId?string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 512
externalThreadKey*string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 1024
rcsMessage?
runId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
threadId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Response Body

ComposeChannelDeliveryResponse

application/json
  1. response
delivery*
duplicate*boolean
curl -X POST "https://example.com/v1/channel-bindings/string/deliveries" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "content": "string",    "externalThreadKey": "string",    "runId": "string",    "threadId": "string"  }'
{  "delivery": {    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "version": 0,    "environmentId": "string",    "organizationId": "string",    "projectId": "string",    "workspaceId": "string",    "attempts": 0,    "bindingId": "string",    "channel": "imessage",    "contentPreview": "string",    "externalThreadKey": "string",    "failedAt": "2019-08-24T14:15:22Z",    "id": "string",    "lastError": "string",    "object": "channel-delivery",    "provider": "aws_end_user_messaging_rcs",    "providerMessageId": "string",    "runId": "string",    "sentAt": "2019-08-24T14:15:22Z",    "status": "failed",    "threadId": "string"  },  "duplicate": true}