Worked request and response samples

{
  "data": {
    "id": "bot_8e7d6c5b4a3f201d5e6c7b8",
    "name": "Order status bot",
    "status": "draft"
  },
  "meta": {
    "request_id": "req_bot",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Copy a request body as written, substitute your own ids, and compare the response envelope. Errors follow Devotel Orbit’s { error, meta } envelope, shown once below under Error envelope.

Create an RCS bot

POST /api/v1/rcs/bots

Request

{
  "name": "Order status bot",
  "brand_id": "brand_2b3c4d5e6f7081a2b3c4d5"
}

{
  "data": {
    "id": "bot_8e7d6c5b4a3f201d5e6c7b8",
    "name": "Order status bot",
    "status": "draft"
  },
  "meta": {
    "request_id": "req_bot",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Scan reach for a segment

POST /api/v1/rcs/reach-scan

Submit the contact segment you want to check. The response separates recipients who can receive RCS from those who fall back to SMS. Request

{
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5"
}

{
  "data": {
    "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
    "reachable": 812,
    "unreachable": 21
  },
  "meta": {
    "request_id": "req_reach",
    "timestamp": "2026-08-01T12:01:00.000Z"
  }
}

List RCS templates for a bot

GET /api/v1/rcs/templates

string

required

The bot whose templates you list.

{
  "data": [
    {
      "name": "order_confirmation",
      "status": "approved"
    }
  ],
  "meta": {
    "request_id": "req_templates",
    "timestamp": "2026-08-01T12:02:00.000Z"
  }
}

Error envelope

422

{
  "error": {
    "code": "VALIDATION_ERROR",
    "status": 422,
    "message": "brand_id: Required"
  },
  "meta": {
    "request_id": "req_...",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Worked request and response samples

Worked request and response samples

Create an RCS bot

Scan reach for a segment

List RCS templates for a bot

Error envelope

​Worked request and response samples

​Create an RCS bot

​Scan reach for a segment

​List RCS templates for a bot

​Error envelope

Worked request and response samples

Create an RCS bot

Scan reach for a segment

List RCS templates for a bot

Error envelope