# RCS 1.0

Lifecycle: **active**

Initial public release.

Base URL: `https://api.example.com/rcs`

- [OpenAPI JSON](https://devdocs.pinnacle.in/docs/rcs/1-0/openapi.json)
- [OpenAPI YAML](https://devdocs.pinnacle.in/docs/rcs/1-0/openapi.yaml)

## Published endpoints

- [POST /api/v1/create-template — create-template - TEXT](https://devdocs.pinnacle.in/docs/rcs/1-0/create-template-text.md)
- [POST /api/v1/create-template — create-template - CAROUSEL](https://devdocs.pinnacle.in/docs/rcs/1-0/create-template-carousel.md)
- [POST /api/v1/create-template — create-template - STANDALONE](https://devdocs.pinnacle.in/docs/rcs/1-0/create-template-standalone.md)
- [GET /api/v1/get-template-details-by-templateId — get template by template id](https://devdocs.pinnacle.in/docs/rcs/1-0/get-template-by-template-id.md)
- [GET /api/v1/get-templateId-by-templateName-and-botId — get template by template name to botId](https://devdocs.pinnacle.in/docs/rcs/1-0/get-template-by-template-name-to-botid.md)
- [GET /api/v1/get-all-templates-by-botid — get templates by botid](https://devdocs.pinnacle.in/docs/rcs/1-0/get-templates-by-botid.md)
- [GET /api/v1/templates/whatsapp-fallback/{{nhea_botId}} — get templates by botid whatsapp fallback](https://devdocs.pinnacle.in/docs/rcs/1-0/get-templates-by-botid-whatsapp-fallback.md)
- [GET /api/v1/get-template-status/{{nhea_botId}}/9 — get-template-status](https://devdocs.pinnacle.in/docs/rcs/1-0/get-template-status.md)
- [GET /api/v1/get-all-template-by-orgId — get-all-template-by-orgId](https://devdocs.pinnacle.in/docs/rcs/1-0/get-all-template-by-orgid.md)
- [GET /api/v1/get-template-preview-by-templateName — get template preview by name](https://devdocs.pinnacle.in/docs/rcs/1-0/get-template-preview-by-name.md)
- [POST /api/v1/update-template — update-template](https://devdocs.pinnacle.in/docs/rcs/1-0/update-template.md)
- [PUT /api/v1/bot/config/set-relay-webhook-url — Set relay webhook url](https://devdocs.pinnacle.in/docs/rcs/1-0/set-relay-webhook-url.md)
- [PUT /mgmt/api/v1/bot/config/set-relay-webhook-url — Set relay webhook url | QA ONPREM](https://devdocs.pinnacle.in/docs/rcs/1-0/set-relay-webhook-url-or-qa-onprem.md)
- [GET /api/v1/bot/config/get-relay-webhook-url — Get relay webhook url](https://devdocs.pinnacle.in/docs/rcs/1-0/get-relay-webhook-url.md)
- [PUT /api/v1/bot/config/set-payload-transform-type — set-payload-transform-type](https://devdocs.pinnacle.in/docs/rcs/1-0/set-payload-transform-type.md)
- [PUT /mgmt/api/v1/bot/config/set-payload-transform-type — set-payload-transform-type | QA ONPREM](https://devdocs.pinnacle.in/docs/rcs/1-0/set-payload-transform-type-or-qa-onprem.md)
- [POST /api/v1/bot/submit_bot_for_verification — submit_bot_for_verification](https://devdocs.pinnacle.in/docs/rcs/1-0/submitbotforverification.md)
- [GET /api/v1/get-all-bots — get-all-bots](https://devdocs.pinnacle.in/docs/rcs/1-0/get-all-bots.md)
- [GET /api/v1/get-all-launched-bots-by-orgId — get-all-launched-bots](https://devdocs.pinnacle.in/docs/rcs/1-0/get-all-launched-bots.md)
- [GET /api/v1/get-bot-details/{{nhea_botId}} — get-bot-details](https://devdocs.pinnacle.in/docs/rcs/1-0/get-bot-details.md)
- [GET /api/v1/get-bot-details/{{nhea_botId}} — get-bot-details Copy](https://devdocs.pinnacle.in/docs/rcs/1-0/get-bot-details-copy.md)
- [GET /api/v1/get-bot-details-by-clientId/NheA46khh4MDvIns — get-bot-details-by-clientId](https://devdocs.pinnacle.in/docs/rcs/1-0/get-bot-details-by-clientid.md)
- [GET /api/v1/get-botId-by-botName — get-botId-by-botName](https://devdocs.pinnacle.in/docs/rcs/1-0/get-botid-by-botname.md)
- [POST /api/v1/add-test-device — add-test-device](https://devdocs.pinnacle.in/docs/rcs/1-0/add-test-device.md)
- [POST /api/v1/create-bot — create-bot](https://devdocs.pinnacle.in/docs/rcs/1-0/create-bot.md) — Request header should have **apikey** Request body validations: - botName: max characters 40 - shortDescription: max characters 100 - botMessageType: should be either "TRANSACTIONAL" or "PROMOTIONAL" - phoneNumbers: max array length 3 - websites: max array length 3 - emails: max array length 3 - color: should be in valid hex code format, example: #FFFFFF - botLogoImage: should be valid url, max size 90 KB, size: 224 px X 224px, Image type: PNG, JPG, JPEG - botBannerImage: should be valid url, max size 360KB, size: 1140px X 448px, Image type: PNG, JPG, JPEG - termsofUseUrl: should be valid url - privacyPolicyUrl: should be valid url Example response ``` json { "status": "SUCCESS", "code": 201, "data": { "botId": "69d54305ca601bxxxxxxx", "botName": "PinnacleTransBotProdCreate1", "message": "Bot Created Successfully" } } ```
- [POST /api/v1/update-bot — update bot](https://devdocs.pinnacle.in/docs/rcs/1-0/update-bot.md) — Request header should have **apikey** and **botId** Request body validations: - botName: max characters 40 - shortDescription: max characters 100 - botMessageType: should be either "TRANSACTIONAL" or "PROMOTIONAL" - phoneNumbers: max array length 3 - websites: max array length 3 - emails: max array length 3 - color: should be in valid hex code format, example: #FFFFFF - botLogoImage: should be valid url, max size 90 KB, size: 224 px X 224px, Image type: PNG, JPG, JPEG - botBannerImage: should be valid url, max size 360KB, size: 1140px X 448px, Image type: PNG, JPG, JPEG - termsofUseUrl: should be valid url - privacyPolicyUrl: should be valid url Example response ``` json { "status": "SUCCESS", "code": 200, "data": "Bot Details Updated Successfully!" } ```
- [POST /api/v1/send-message — send-message-template-per-number](https://devdocs.pinnacle.in/docs/rcs/1-0/send-message-template-per-number.md)
- [POST /api/v1/send-message — send-message-common-template-for batch](https://devdocs.pinnacle.in/docs/rcs/1-0/send-message-common-template-for-batch.md)
- [POST /api/v1/send-message — send-message-no-template-batch](https://devdocs.pinnacle.in/docs/rcs/1-0/send-message-no-template-batch.md)
- [POST /api/v1/send-message — send-message-no-template single](https://devdocs.pinnacle.in/docs/rcs/1-0/send-message-no-template-single.md)
- [POST /api/v1/send-freeflow-message — Freeflow | Richcard](https://devdocs.pinnacle.in/docs/rcs/1-0/freeflow-or-richcard.md)
- [POST /api/v1/send-freeflow-message — Freeflow | text](https://devdocs.pinnacle.in/docs/rcs/1-0/freeflow-or-text.md)
- [POST /api/v1/send-freeflow-message — FreeFlow | Carousel](https://devdocs.pinnacle.in/docs/rcs/1-0/freeflow-or-carousel.md)
- [GET /api/v1/get-message-status-by-messageId/68218acedb298103bc8d5931/STAGE_65c4eabecf32f14a18535f10_APIdfsdfaccv234-20251203_3a7ce62400 — Get status by message ID](https://devdocs.pinnacle.in/docs/rcs/1-0/get-status-by-message-id.md)