Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-201,3412,1385.0 MB

3fdc16374d70

RCS Agents

Create an RCS agent

Creates an editable RCS agent draft under a brand. The Idempotency-Key is scoped to the authenticated organization. Reusing the key with the same request returns the original agent, while reusing it with a different request returns a conflict.

post/rcs/agents

Headers

Idempotency-Keystring required

A caller-generated key containing letters, numbers, underscores, or hyphens. Reuse the same key and request body when retrying the same logical agent creation.

Request body

brand_idstring uuid required
display_namestring required
hosting_regionstring nullable
profile_idstring nullable

A Messaging Profile owned by the authenticated organization. When omitted, the agent inherits the brand profile.

use_case'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP' required

Example request

{
  "brand_id": "11111111-1111-4111-8111-111111111111",
  "configuration": {
    "basics": {
      "brand_color": "#123456",
      "description": "Order confirmations and delivery updates",
      "email": {
        "address": "support@example.com",
        "label": "Support"
      },
      "hero_url": "https://www.example.com/rcs/hero.png",
      "logo_url": "https://www.example.com/rcs/logo.png",
      "privacy_policy_url": "https://www.example.com/privacy",
      "terms_and_conditions_url": "https://www.example.com/terms"
    }
  },
  "display_name": "Acme Order Updates",
  "use_case": "TRANSACTIONAL"
}

Response

The agent draft was created or replayed from the idempotency record.

agent_idstring uuid required
basics_status'SUBMITTED' | 'APPROVED' | 'REJECTED' required
billing_category'NON_CONVERSATIONAL' | 'CONVERSATIONAL' required
brand_idstring uuid required
campaign_status'SUBMITTED' | 'APPROVED' | 'REJECTED' required
display_namestring required
hosting_regionstring nullable required
profile_idstring nullable required
status'CREATED' | 'SUBMITTED' | 'VERIFYING' | 'VERIFIED' | 'LAUNCHING' | 'LAUNCHED' | 'LIVE' | 'REJECTED' | 'FAILED' required
testing_status'SUBMITTED' | 'APPROVED' | 'REJECTED' required
use_case'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP' required

Example response

{
  "agent_id": "22222222-2222-4222-8222-222222222222",
  "basics_status": "SUBMITTED",
  "billing_category": "NON_CONVERSATIONAL",
  "brand_id": "11111111-1111-4111-8111-111111111111",
  "campaign_status": null,
  "capabilities": {
    "brand_entity": true,
    "brand_verification": true,
    "campaigns": false,
    "distinct_launch_phase": false,
    "invite_test_devices": false,
    "per_carrier_approval": false,
    "submission_sections": true,
    "templates": false,
    "vendor_webhooks": false
  },
  "carrier_approvals": [],
  "configuration": {
    "basics": {
      "brand_color": "#123456",
      "description": "Order confirmations and delivery updates",
      "email": {
        "address": "support@example.com",
        "label": "Support"
      },
      "hero_url": "https://www.example.com/rcs/hero.png",
      "logo_url": "https://www.example.com/rcs/logo.png",
      "privacy_policy_url": "https://www.example.com/privacy",
      "terms_and_conditions_url": "https://www.example.com/terms"
    },
    "campaign": null,
    "testing": null
  },
  "display_name": "Acme Order Updates",
  "hosting_region": null,
  "profile_id": "40000000-0000-0000-0000-000000000001",
  "status": "SUBMITTED",
  "test_devices": [],
  "testing_status": null,
  "use_case": "TRANSACTIONAL"
}