API REFERENCE

Programs API

The SimplyRCS programs API has 5 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.

Customer-safe brand/campaign messaging programs, sender attachments, and readiness status.

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

Endpoints in this section

GET /v1/programs
GET /v1/programs/{id}
GET /v1/programs/{id}/status
POST /v1/programs/{id}/senders
DELETE /v1/programs/{id}/senders/{senderId}

GET/v1/programs

List messaging programs

Returns customer-safe brand/campaign program summaries, sender attachments, readiness, and next action without exposing provider names or internal routing identifiers.

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

Query parameters

Name	Type	Required
`page`	`integer`	No
`limit`	`integer`	No
`status`	`"DRAFT" \| "ACTIVE" \| "ARCHIVED"`	No

Responses

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

Example request

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

GET/v1/programs/{id}

Get a messaging program

Returns a customer-safe messaging program detail with current brand/campaign submission state and attached sender summary.

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

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

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

GET/v1/programs/{id}/status

Get messaging program status

Returns readiness, required actions, next action, and current customer-visible status for a messaging program.

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

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

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

POST/v1/programs/{id}/senders

Attach a sender to a messaging program

Attaches a same-account sender ID to a program as PRIMARY, FALLBACK, or TEST, validating protocol compatibility and preventing duplicate active attachments.

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

AttachProgramSenderBody · optional

Responses

Status	Returns	Description
`201`	`AttachProgramSenderResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

DELETE/v1/programs/{id}/senders/{senderId}

Detach a sender from a messaging program

Detaches an active sender attachment from a messaging program while preserving the audit trail.

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

Path parameters

Name	Type	Description
`id` required	`string`
`senderId` required	`string`

Responses

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

Example request

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

Other parts of the API

Get a free sender ID test Read the RCS API guide