API REFERENCE

Common API

The SimplyRCS common API has 23 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.

Health, authentication, onboarding, assets, team, and shared resources.

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

GET/health

Health check

GET https://api.simplyrcs.com/health

Responses

Status	Returns	Description
`200`	`HealthResponse`	Successful response
`400`	`ErrorResponse`	Validation error

Example request

curl -X GET https://api.simplyrcs.com/health

GET/v1/landing-page-templates

List landing page templates

Returns the platform-provided landing page template catalog.

GET https://api.simplyrcs.com/v1/landing-page-templates · requires an API key

Responses

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

Example request

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

GET/v1/landing-pages

List landing pages

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

Query parameters

Name	Type	Required
`status`	`LandingPageStatus`	No
`page`	`integer`	No
`limit`	`integer`	No

Responses

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

Example request

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

POST/v1/landing-pages

Create a landing page

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

Request body

LandingPageCreateRequest · optional

Responses

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

Example request

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

GET/v1/landing-pages/{id}

Get a landing page

GET https://api.simplyrcs.com/v1/landing-pages/{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 GET https://api.simplyrcs.com/v1/landing-pages/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/v1/landing-pages/{id}

Update a landing page

PATCH https://api.simplyrcs.com/v1/landing-pages/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

LandingPageUpdateRequest · optional

Responses

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

Example request

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

DELETE/v1/landing-pages/{id}

Delete a landing page

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

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

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

POST/v1/landing-pages/{id}/publish

Publish a landing page

POST https://api.simplyrcs.com/v1/landing-pages/{id}/publish · 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 POST https://api.simplyrcs.com/v1/landing-pages/{id}/publish \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/landing-pages/{id}/unpublish

Unpublish a landing page

POST https://api.simplyrcs.com/v1/landing-pages/{id}/unpublish · 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 POST https://api.simplyrcs.com/v1/landing-pages/{id}/unpublish \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/landing-pages/{id}/submissions

List landing page submissions

GET https://api.simplyrcs.com/v1/landing-pages/{id}/submissions · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Query parameters

Name	Type	Required	Description
`page`	`integer`	No
`limit`	`integer`	No

Responses

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

Example request

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

GET/v1/assets

List assets

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

Query parameters

Name	Type	Required	Description
`folderId`	`string`	No	Filter by folder. Pass the literal string 'null' for unfiled assets.
`type`	`AssetType`	No
`search`	`string`	No
`includeErrors`	`"true" \| "false"`	No
`page`	`integer`	No
`limit`	`integer`	No
`sort`	`"name" \| "size_bytes" \| "created_at"`	No
`order`	`"asc" \| "desc"`	No

Responses

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

Example request

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

POST/v1/assets/upload

Upload an asset

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

Request body

multipart/form-data · optional

Responses

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

Example request

curl -X POST https://api.simplyrcs.com/v1/assets/upload \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F 'file=@./logo.png'

POST/v1/assets/upload/batch

Upload assets in batch

POST https://api.simplyrcs.com/v1/assets/upload/batch · requires an API key

Request body

multipart/form-data · optional

Responses

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

Example request

curl -X POST https://api.simplyrcs.com/v1/assets/upload/batch \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F 'files=@./logo.png' -F 'files=@./hero.jpg'

GET/v1/assets/{id}

Get an asset

GET https://api.simplyrcs.com/v1/assets/{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 GET https://api.simplyrcs.com/v1/assets/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/v1/assets/{id}

Update asset metadata

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

AssetUpdateRequest · optional

Responses

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

Example request

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

DELETE/v1/assets/{id}

Delete an asset

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

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

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

POST/v1/assets/{id}/crop

Crop an asset

Creates a new derived image asset from the crop region. Image and GIF assets only.

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

AssetCropRequest · optional

Responses

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

Example request

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

POST/v1/assets/{id}/resize

Resize an asset

Creates a new derived JPEG asset at the requested dimensions. Image and GIF assets only.

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

AssetResizeRequest · optional

Responses

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

Example request

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

GET/v1/assets/{id}/variant/{variant}

Fetch an asset variant

Streams the binary content of a processed asset variant (e.g. a thumbnail).

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

Path parameters

Name	Type	Description
`id` required	`Id`
`variant` required	`string`

Responses

Status	Returns	Description
`200`		Binary variant content (content type matches the stored file).
`401`	`ErrorResponse`	Authentication failed
`404`	`ErrorResponse`	Variant not found

Example request

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

GET/v1/asset-folders

List asset folders

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

Query parameters

Name	Type	Required	Description
`parentId`	`string`	No	Filter by parent folder. Pass the literal string 'null' for root folders.

Responses

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

Example request

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

POST/v1/asset-folders

Create an asset folder

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

Request body

AssetFolderCreateRequest · optional

Responses

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

Example request

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

PATCH/v1/asset-folders/{id}

Update an asset folder

PATCH https://api.simplyrcs.com/v1/asset-folders/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

AssetFolderUpdateRequest · optional

Responses

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

Example request

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

DELETE/v1/asset-folders/{id}

Delete an asset folder

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

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

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

Example request

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

Other parts of the API

Get a free sender ID test Read the RCS API guide

Common API

Endpoints in this section

GET/health

Responses

Example request

GET/v1/landing-page-templates

Responses

Example request

GET/v1/landing-pages

Query parameters

Responses

Example request

POST/v1/landing-pages

Request body

Responses

Example request

GET/v1/landing-pages/{id}

Path parameters

Responses

Example request

PATCH/v1/landing-pages/{id}

Path parameters

Request body

Responses

Example request

DELETE/v1/landing-pages/{id}

Path parameters

Responses

Example request

POST/v1/landing-pages/{id}/publish

Path parameters

Responses

Example request

POST/v1/landing-pages/{id}/unpublish

Path parameters

Responses

Example request

GET/v1/landing-pages/{id}/submissions

Path parameters

Query parameters

Responses

Example request

GET/v1/assets

Query parameters

Responses

Example request

POST/v1/assets/upload

Request body

Responses

Example request

POST/v1/assets/upload/batch

Request body

Responses

Example request

GET/v1/assets/{id}

Path parameters

Responses

Example request

PATCH/v1/assets/{id}

Path parameters

Request body

Responses

Example request

DELETE/v1/assets/{id}

Path parameters

Responses

Example request

POST/v1/assets/{id}/crop

Path parameters

Request body

Responses

Example request

POST/v1/assets/{id}/resize

Path parameters

Request body

Responses

Example request

GET/v1/assets/{id}/variant/{variant}

Path parameters

Responses