API REFERENCE

Compliance API

The SimplyRCS compliance API has 15 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.

DNC, consent, TCPA, and compliance reporting.

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

GET/v1/compliance/dnc

List DNC entries

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

Query parameters

Name	Type	Required	Description
`search`	`string`	No	Phone-number substring filter.
`page`	`integer`	No
`limit`	`integer`	No

Responses

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

Example request

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

POST/v1/compliance/dnc

Create a DNC entry

POST https://api.simplyrcs.com/v1/compliance/dnc · requires an API key

Request body

DncCreateRequest · optional

Responses

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

Example request

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

POST/v1/compliance/dnc/batch

Create DNC entries in batch

POST https://api.simplyrcs.com/v1/compliance/dnc/batch · requires an API key

Request body

DncBatchRequest · optional

Responses

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

Example request

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

DELETE/v1/compliance/dnc/{id}

Delete a DNC entry

Requires brand admin or platform admin access.

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

GET/v1/compliance/reports/{type}

Generate a compliance report

Downloads a consent, opt-outs, or DNC report as a CSV or JSON attachment.

GET https://api.simplyrcs.com/v1/compliance/reports/{type} · requires an API key

Path parameters

Name	Type	Description
`type` required	`"consent" \| "opt-outs" \| "dnc"`

Query parameters

Name	Type	Required
`startDate`	`string`	No
`endDate`	`string`	No
`format`	`"csv" \| "json"`	No

Responses

Status	Returns	Description
`200`	`object[]`	Report file (Content-Disposition: attachment).
`401`	`ErrorResponse`	Authentication failed
`404`	`ErrorResponse`	Unknown report type

Example request

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

POST/v1/compliance/override

Create a compliance override

Requires brand admin or platform admin access. Creates a 24-hour consent override and writes a ConsentAuditLog entry. DNC-listed contacts cannot be overridden (422).

POST https://api.simplyrcs.com/v1/compliance/override · requires an API key

Request body

ComplianceOverrideRequest · optional

Responses

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

Example request

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

PATCH/v1/contacts/{id}/tcpa

Update TCPA settings for a contact

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

ComplianceTcpaUpdateRequest · optional

Responses

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

Example request

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

GET/v1/content-rules

List content rules

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

Query parameters

Name	Type	Required
`page`	`integer`	No
`limit`	`integer`	No
`search`	`string`	No
`action`	`"block" \| "flag"`	No
`patternType`	`"keyword" \| "regex"`	No

Responses

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

Example request

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

POST/v1/content-rules

Create a content rule

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

Request body

ContentRuleCreateRequest · optional

Responses

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

Example request

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

PATCH/v1/content-rules/{id}

Update a content rule

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

ContentRuleUpdateRequest · 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/content-rules/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/content-rules/{id}

Delete a content rule

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

GET/v1/keyword-rules

List keyword rules

Returns global rules merged with org-level custom rules and overrides. Not paginated.

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

Responses

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

Example request

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

POST/v1/keyword-rules

Create a keyword rule

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

Request body

KeywordRuleCreateRequest · optional

Responses

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

Example request

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

PATCH/v1/keyword-rules/{id}

Update a keyword rule

Global keyword rules cannot be edited directly (403).

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

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

KeywordRuleUpdateRequest · 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/keyword-rules/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/keyword-rules/{id}

Delete a keyword rule

Global keyword rules cannot be deleted (403).

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

Other parts of the API

Get a free sender ID test Read the RCS API guide