Send a test RICH RCS card (platform owner only)

Sends a Twilio Content Template (rich card / carousel / quick-reply) through the workspace Messaging Service with automatic SMS fallback. Provide either a stored templateId or a raw contentSid. Same gating + consent rules as text RCS (RCS_MESSAGING flag, workspace_rcs_config, sandbox, DNC, opted_in_sms). Always sends to the contact's own phone number. SaaS platform owner access required.

POST

https://api.channelautomation.com/api/rcs/workspaces/{workspaceId}/test-send-card

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required

Request body JSON required

contactId
string
required
Contact UUID. Drives consent gates.
templateId
optional
string
rcs_content_templates.id (resolves contentSid + mapping)
contentSid
optional
string
Twilio Content SID (HX…) — alternative to templateId
contentVariables
optional
object
Explicit {{n}}→value map; bypasses mapping resolution.
variableMapping
optional
object
Mapping override (only used with a raw contentSid).
bodyPreview
optional
string
Human-readable text stored on the LiveChat row.
isTest
optional
boolean
Dry run — runs all gates, skips the Twilio send + DB insert.

Returns

200

Send attempt completed. ok:true with a messageSid when sent; ok:false with skipped:true and a reason when intentionally blocked.

400

Missing contactId, or neither templateId nor contentSid.

401

Authentication required

JSON

error
optional
string
success
optional
boolean

403

SaaS owner access required.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

502

Twilio send failed.

503

Identity verification is temporarily unavailable.

curl --request POST \ --url 'https://api.channelautomation.com/api/rcs/workspaces/<workspaceId>/test-send-card' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "contactId": "string", "templateId": "string", "contentSid": "string", "contentVariables": {}, "variableMapping": {}, "bodyPreview": "string", "isTest": true } '