Support · Contact · Legal
Verified RCS · SMS · MMS · Log in
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 194 endpoints · Pricing

GET/health

Health check

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

Responses

StatusReturnsDescription
200HealthResponseSuccessful response
400ErrorResponseValidation 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

StatusReturnsDescription
200LandingPageTemplateListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/landing-page-templates \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

GET/v1/landing-pages

List landing pages

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

Query parameters

NameTypeRequiredDescription
statusLandingPageStatusNo
pageintegerNo
limitintegerNo

Responses

StatusReturnsDescription
200LandingPageListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/landing-pages \
  -H "Authorization: Bearer $SIMPLYRCS_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

FieldTypeRequiredDescription
titlestringYes
slugstringNo
blocksJsonLandingPageBlock[]No
themeJsonLandingPageThemeNo
experienceTypeLandingPageExperienceTypeNo

Responses

StatusReturnsDescription
201LandingPageResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/landing-pages \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Example title",
    "themeJson": {},
    "experienceType": "GENERAL_PAGE"
  }'

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

GET/v1/landing-pages/{id}

Get a landing page

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

Path parameters

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/landing-pages/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_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

NameTypeDescription
id requiredId

Request body

LandingPageUpdateRequest · optional

FieldTypeRequiredDescription
titlestringNo
slugstringNo
blocksJsonLandingPageBlock[]No
themeJsonstringNo
experienceTypeLandingPageExperienceTypeNo
seoTitlestringNo
seoDescriptionstringNo
ogImageUrlstringNo
linkedBotIdstringNo
linkedSenderIdIdstringNo
updatedAtstringNoOptimistic-concurrency check: pass the last-seen updatedAt; a mismatch returns 409.

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X PATCH https://api.simplyrcs.com/v1/landing-pages/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "experienceType": "GENERAL_PAGE",
    "updatedAt": "2026-11-01T15:00:00Z"
  }'

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

DELETE/v1/landing-pages/{id}

Delete a landing page

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

Path parameters

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200SuccessResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/landing-pages/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_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

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/landing-pages/{id}/publish \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

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

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/landing-pages/{id}/unpublish \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

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

NameTypeDescription
id requiredId

Query parameters

NameTypeRequiredDescription
pageintegerNo
limitintegerNo

Responses

StatusReturnsDescription
200LandingPageSubmissionListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

GET/v1/assets

List assets

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

Query parameters

NameTypeRequiredDescription
folderIdstringNoFilter by folder. Pass the literal string 'null' for unfiled assets.
typeAssetTypeNo
searchstringNo
includeErrors"true" | "false"No
pageintegerNo
limitintegerNo
sort"name" | "size_bytes" | "created_at"No
order"asc" | "desc"No

Responses

StatusReturnsDescription
200AssetListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/assets \
  -H "Authorization: Bearer $SIMPLYRCS_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

StatusReturnsDescription
201AssetResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/assets/upload \
  -H "Authorization: Bearer $SIMPLYRCS_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

StatusReturnsDescription
201AssetBatchUploadResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/assets/upload/batch \
  -H "Authorization: Bearer $SIMPLYRCS_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

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/assets/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

PATCH/v1/assets/{id}

Update asset metadata

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

Path parameters

NameTypeDescription
id requiredId

Request body

AssetUpdateRequest · optional

FieldTypeRequiredDescription
displayNamestringNo
folderIdstringNo

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X PATCH https://api.simplyrcs.com/v1/assets/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Example display",
    "folderId": "folder_01h9"
  }'

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

DELETE/v1/assets/{id}

Delete an asset

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

Path parameters

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200SuccessResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/assets/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_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

NameTypeDescription
id requiredId

Request body

AssetCropRequest · optional

FieldTypeRequiredDescription
xnumberNo
ynumberNo
widthnumberNo
heightnumberNo
outputFormat"jpeg" | "png" | "webp"No

Responses

StatusReturnsDescription
201objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/assets/{id}/crop \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "outputFormat": "jpeg"
  }'

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

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

NameTypeDescription
id requiredId

Request body

AssetResizeRequest · optional

FieldTypeRequiredDescription
widthnumberNo
heightnumberNo
fit"cover" | "contain" | "fill"No

Responses

StatusReturnsDescription
201objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/assets/{id}/resize \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "fit": "cover"
  }'

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

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

NameTypeDescription
id requiredId
variant requiredstring

Responses

StatusReturnsDescription
200Binary variant content (content type matches the stored file).
401ErrorResponseAuthentication failed
404ErrorResponseVariant not found

Example request

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

GET/v1/asset-folders

List asset folders

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

Query parameters

NameTypeRequiredDescription
parentIdstringNoFilter by parent folder. Pass the literal string 'null' for root folders.

Responses

StatusReturnsDescription
200AssetFolderListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/asset-folders \
  -H "Authorization: Bearer $SIMPLYRCS_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

FieldTypeRequiredDescription
namestringYes
parentIdstringNo

Responses

StatusReturnsDescription
201AssetFolderResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

PATCH/v1/asset-folders/{id}

Update an asset folder

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

Path parameters

NameTypeDescription
id requiredId

Request body

AssetFolderUpdateRequest · optional

FieldTypeRequiredDescription
namestringNo
parentIdstringNo

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

Example body: built from the request schema (required fields first), with illustrative values; the field table above lists every field the schema accepts.

DELETE/v1/asset-folders/{id}

Delete an asset folder

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

Path parameters

NameTypeDescription
id requiredId

Responses

StatusReturnsDescription
200SuccessResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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