API REFERENCE

Submissions API

The SimplyRCS submissions API has 7 public endpoints. Every endpoint below is documented with its parameters, responses and an example request. The reference is public and needs no account; a scoped API key is required only to make live calls.

Brand, campaign, sender-ID, and RCS-agent regulatory submissions.

Base URL https://api.simplyrcs.com · All 195 endpoints · Pricing

Endpoints in this section

POST /v1/sender-ids/{id}/launch
POST /v1/sender-ids/{id}/submit
POST /v1/sender-ids/{id}/refresh-status
POST /v1/sender-ids/{id}/brand/register
GET /v1/sender-ids/{id}/brand/status
POST /v1/sender-ids/{id}/campaign/register
GET /v1/sender-ids/{id}/campaign/status

POST/v1/sender-ids/{id}/launch

Promote a tested RCS agent to go-live (LAUNCH_PENDING)

POST https://api.simplyrcs.com/v1/sender-ids/{id}/launch · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`LaunchSenderIdResponse`	The audited go-live gate: promotes an RCS agent from TESTING to LAUNCH_PENDING so it can then be submitted to the carrier. Idempotent if already LAUNCH_PENDING. Replies 400 for a non-RCS sender and 409 if the agent is not in the TESTING phase.
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

POST/v1/sender-ids/{id}/submit

Submit a sender ID for regulatory vetting

POST https://api.simplyrcs.com/v1/sender-ids/{id}/submit · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

SubmitSenderIdBody · optional

Responses

Status	Returns	Description
`200`	`SubmitSenderIdResponse`	Submission accepted. On an upstream submission failure the route replies 502 with { senderId, submission: { status: "failed", error } }.
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

POST/v1/sender-ids/{id}/refresh-status

Refresh submission status from the upstream registry

POST https://api.simplyrcs.com/v1/sender-ids/{id}/refresh-status · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`RefreshSenderIdStatusResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

POST/v1/sender-ids/{id}/brand/register

POST https://api.simplyrcs.com/v1/sender-ids/{id}/brand/register · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

RegisterSenderBrandBody · optional

Responses

Status	Returns	Description
`200`	`RegisterSenderBrandResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

GET/v1/sender-ids/{id}/brand/status

Get sender brand registration status

GET https://api.simplyrcs.com/v1/sender-ids/{id}/brand/status · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`SenderBrandStatusResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

POST/v1/sender-ids/{id}/campaign/register

POST https://api.simplyrcs.com/v1/sender-ids/{id}/campaign/register · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

RegisterSenderCampaignBody · optional

Responses

Status	Returns	Description
`200`	`RegisterSenderCampaignResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

GET/v1/sender-ids/{id}/campaign/status

Get sender campaign registration status

GET https://api.simplyrcs.com/v1/sender-ids/{id}/campaign/status · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`SenderCampaignStatusResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

Other parts of the API

Get a free sender ID test Read the RCS API guide