Support · Contact · Legal
Verified RCS · SMS · MMS · Log in
API REFERENCE

Events API

The SimplyRCS events API has 10 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.

Event-triggered and acquisition messaging workflows.

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

POST/v1/events

Create an event-triggered message

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

Request body

EventTriggerRequest · optional

FieldTypeRequiredDescription
event_typestringYes
dataobjectYes
channel"RCS" | "SMS" | "MMS" | "WHATSAPP"No

Responses

StatusReturnsDescription
200EventResultSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/events \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "event_type": "text",
    "data": {},
    "channel": "RCS"
  }'

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/events/batch

Create event-triggered messages in batch

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

Request body

EventBatchRequest · optional

FieldTypeRequiredDescription
eventsEventTriggerRequest[]Yes

Responses

StatusReturnsDescription
200EventBatchResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/events/batch \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "events": [
      {
        "event_type": "text",
        "data": {},
        "channel": "RCS"
      }
    ]
  }'

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/acquisition/{campaignId}/enroll

Enroll a contact via acquisition campaign

POST https://api.simplyrcs.com/v1/acquisition/{campaignId}/enroll · requires an API key

Path parameters

NameTypeDescription
campaignId requiredId

Request body

AcquisitionEnrollRequest · optional

FieldTypeRequiredDescription
phonestringYesE.164 phone number.
firstNamestringNo
lastNamestringNo
emailstringNo
metadataobjectNo
channelIdstringNo

Responses

StatusReturnsDescription
200AcquisitionEnrollResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/acquisition/{campaignId}/enroll \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "+14155550142"
  }'

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

GET/acquisition-campaigns

List acquisition campaigns

GET https://api.simplyrcs.com/acquisition-campaigns · requires an API key

Query parameters

NameTypeRequiredDescription
statusAcquisitionCampaignStatusNo
typeAcquisitionCampaignTypeNo

Responses

StatusReturnsDescription
200AcquisitionCampaignListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/acquisition-campaigns \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

POST/acquisition-campaigns

Create acquisition campaign

POST https://api.simplyrcs.com/acquisition-campaigns · requires an API key

Request body

AcquisitionCampaignCreateRequest · optional

FieldTypeRequiredDescription
namestringYes
listIdIdYes
typeAcquisitionCampaignTypeYes
keywordstringNoRequired for KEYWORD campaigns.
shortcodestringNoRequired for KEYWORD campaigns.
welcomeMessagestringNo
doubleOptInbooleanNo
confirmationMessagestringNo
webFormConfigobjectNoOnly for WEB_FORM and QR_CODE campaigns.

Responses

StatusReturnsDescription
201AcquisitionCampaignSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/acquisition-campaigns \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example name",
    "listId": "lst_3c1d",
    "type": "KEYWORD"
  }'

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

GET/acquisition-campaigns/{campaignId}

Get acquisition campaign

GET https://api.simplyrcs.com/acquisition-campaigns/{campaignId} · requires an API key

Path parameters

NameTypeDescription
campaignId requiredId

Responses

StatusReturnsDescription
200AcquisitionCampaignDetailSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X GET https://api.simplyrcs.com/acquisition-campaigns/{campaignId} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

PUT/acquisition-campaigns/{campaignId}

Update acquisition campaign

type, listId, keyword, and shortcode are immutable.

PUT https://api.simplyrcs.com/acquisition-campaigns/{campaignId} · requires an API key

Path parameters

NameTypeDescription
campaignId requiredId

Request body

AcquisitionCampaignUpdateRequest · optional

FieldTypeRequiredDescription
namestringNo
welcomeMessagestringNo
doubleOptInbooleanNo
confirmationMessagestringNo
statusAcquisitionCampaignStatusNo
webFormConfigobjectNo

Responses

StatusReturnsDescription
200AcquisitionCampaignSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X PUT https://api.simplyrcs.com/acquisition-campaigns/{campaignId} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "ACTIVE"
  }'

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

DELETE/acquisition-campaigns/{campaignId}

Delete acquisition campaign

DELETE https://api.simplyrcs.com/acquisition-campaigns/{campaignId} · requires an API key

Path parameters

NameTypeDescription
campaignId requiredId

Responses

StatusReturnsDescription
204Campaign deleted (no content).
401ErrorResponseAuthentication failed
404ErrorResponseCampaign not found

Example request

curl -X DELETE https://api.simplyrcs.com/acquisition-campaigns/{campaignId} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

POST/acquisition-campaigns/{campaignId}/generate-qr

Generate acquisition campaign QR code

No request body.

POST https://api.simplyrcs.com/acquisition-campaigns/{campaignId}/generate-qr · requires an API key

Path parameters

NameTypeDescription
campaignId requiredId

Responses

StatusReturnsDescription
200AcquisitionCampaignQrResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/acquisition-campaigns/{campaignId}/generate-qr \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY"

POST/public/acquisition/{campaignId}/enroll

Public acquisition enrollment

Public, CORS-enabled enrollment for web forms and QR codes. Rate limited to 10 requests/minute per IP.

POST https://api.simplyrcs.com/public/acquisition/{campaignId}/enroll

Path parameters

NameTypeDescription
campaignId requiredId

Request body

AcquisitionEnrollRequest · optional

FieldTypeRequiredDescription
phonestringYesE.164 phone number.
firstNamestringNo
lastNamestringNo
emailstringNo
metadataobjectNo
channelIdstringNo

Responses

StatusReturnsDescription
200AcquisitionPublicEnrollResponseSuccessful response
400ErrorResponseValidation error

Example request

curl -X POST https://api.simplyrcs.com/public/acquisition/{campaignId}/enroll \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "+14155550142"
  }'

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