Bots API

GET/v1/bots

List bots

GET https://api.simplyrcs.com/v1/bots · requires an API key

Query parameters

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/bots \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/bots

Create a bot

POST https://api.simplyrcs.com/v1/bots · requires an API key

Request body

BotCreateRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/bots \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/bots/{id}

Get a bot

GET https://api.simplyrcs.com/v1/bots/{id} · requires an API key

Path parameters

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/bots/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/v1/bots/{id}

Update a bot

Updates name, channel, or the draft flow. A changed draft flow bumps the version and records a revision; status transitions between PUBLISHED and MODIFIED based on whether the draft matches the published flow.

PUT https://api.simplyrcs.com/v1/bots/{id} · requires an API key

Path parameters

Request body

BotUpdateRequest · optional

Responses

Example request

curl -X PUT https://api.simplyrcs.com/v1/bots/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/bots/{id}

Delete a bot

DELETE https://api.simplyrcs.com/v1/bots/{id} · requires an API key

Path parameters

Responses

Example request

curl -X DELETE https://api.simplyrcs.com/v1/bots/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/bots/{id}/publish

Publish a bot

Validates the draft flow (must have nodes and a Start node and pass content validation) and copies it to the published flow. Validation failures return 400 with a validationErrors array.

POST https://api.simplyrcs.com/v1/bots/{id}/publish · requires an API key

Path parameters

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/bots/{id}/publish \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/bots/{id}/validate

Validate a bot flow

POST https://api.simplyrcs.com/v1/bots/{id}/validate · requires an API key

Path parameters

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/bots/{id}/validate \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/bots/{id}/revisions

List bot revisions

GET https://api.simplyrcs.com/v1/bots/{id}/revisions · requires an API key

Path parameters

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/bots/{id}/revisions \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/bots/{id}/testers

List bot testers and RCS invite status

GET https://api.simplyrcs.com/v1/bots/{id}/testers · requires an API key

Path parameters

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/bots/{id}/testers \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/bots/{id}/testers

Add a bot tester and optionally send RCS opt-in invite

Provide either contactId (existing contact) or phone (E.164; a contact is created or reused). When the bot is linked to a provider-managed RCS sender, an RCS test-device opt-in invite is sent unless sendRcsInvite is false.

POST https://api.simplyrcs.com/v1/bots/{id}/testers · requires an API key

Path parameters

Request body

BotTesterAddRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/bots/{id}/testers \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'