> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Worked request and response samples

> Worked samples for RCS onboarding: register a bot, check its reach, and read template analytics. Each sample shows the request, the success envelope, and the error envelope to expect.

## Worked request and response samples

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

<Note>
  `POST /api/v1/rcs/bots`
</Note>

**Request**

```json theme={null}
{
  "name": "Order status bot",
  "brand_id": "brand_2b3c4d5e6f7081a2b3c4d5"
}
```

<ResponseExample>
  ```json 201 theme={null}
  {
    "data": {
      "id": "bot_8e7d6c5b4a3f201d5e6c7b8",
      "name": "Order status bot",
      "status": "draft"
    },
    "meta": {
      "request_id": "req_bot",
      "timestamp": "2026-08-01T12:00:00.000Z"
    }
  }
  ```
</ResponseExample>

### Scan reach for a segment

<Note>
  `POST /api/v1/rcs/reach-scan`
</Note>

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

**Request**

```json theme={null}
{
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5"
}
```

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": {
      "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
      "reachable": 812,
      "unreachable": 21
    },
    "meta": {
      "request_id": "req_reach",
      "timestamp": "2026-08-01T12:01:00.000Z"
    }
  }
  ```
</ResponseExample>

### List RCS templates for a bot

<Note>
  `GET /api/v1/rcs/templates`
</Note>

<ParamField query="bot_id" type="string" required>
  The bot whose templates you list.
</ParamField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "name": "order_confirmation",
        "status": "approved"
      }
    ],
    "meta": {
      "request_id": "req_templates",
      "timestamp": "2026-08-01T12:02:00.000Z"
    }
  }
  ```
</ResponseExample>

### Error envelope

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