API REFERENCE

API Keys API

The SimplyRCS api keys API has 4 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.

API key lifecycle management.

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

GET/v1/api-keys

List API keys

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

Responses

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

Example request

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

POST/v1/api-keys

Create an API key

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

Request body

CreateApiKeyBody · optional

Responses

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

Example request

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

DELETE/v1/api-keys/{id}

Revoke an API key

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

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

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

POST/v1/api-keys/{id}/rotate

Rotate an API key secret

Rotates the key secret in place: keeps the same id, name, access scope, and expiry. A new secret and prefix are minted and the old secret stops authenticating immediately. If an expiresAt was set at creation the rotated key inherits that expiry unchanged; to change expiry, revoke and create a new key.

POST https://api.simplyrcs.com/v1/api-keys/{id}/rotate · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

curl -X POST https://api.simplyrcs.com/v1/api-keys/{id}/rotate \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Production integration" }'

Other parts of the API

Get a free sender ID test Read the RCS API guide