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 195 endpoints · Pricing

Endpoints in this section

POST /v1/events
POST /v1/events/batch
POST /v1/acquisition/{campaignId}/enroll
GET /acquisition-campaigns
POST /acquisition-campaigns
GET /acquisition-campaigns/{campaignId}
PUT /acquisition-campaigns/{campaignId}
DELETE /acquisition-campaigns/{campaignId}
POST /acquisition-campaigns/{campaignId}/generate-qr
POST /public/acquisition/{campaignId}/enroll

POST/v1/events

Create an event-triggered message

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

Request body

EventTriggerRequest · optional

Responses

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

Example request

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

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

Responses

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

Example request

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

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

Name	Type	Description
`campaignId` required	`Id`

Request body

AcquisitionEnrollRequest · optional

Responses

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

Example request

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

GET/acquisition-campaigns

List acquisition campaigns

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

Query parameters

Name	Type	Required	Description
`status`	`AcquisitionCampaignStatus`	No
`type`	`AcquisitionCampaignType`	No

Responses

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

Example request

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

POST/acquisition-campaigns

Create acquisition campaign

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

Request body

AcquisitionCampaignCreateRequest · optional

Responses

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

Example request

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

GET/acquisition-campaigns/{campaignId}

Get acquisition campaign

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

Path parameters

Name	Type	Description
`campaignId` required	`Id`

Responses

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

Example request

curl -X GET https://api.simplyrcs.com/acquisition-campaigns/{campaignId} \
  -H 'Authorization: Bearer YOUR_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

Name	Type	Description
`campaignId` required	`Id`

Request body

AcquisitionCampaignUpdateRequest · optional

Responses

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

Example request

curl -X PUT https://api.simplyrcs.com/acquisition-campaigns/{campaignId} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/acquisition-campaigns/{campaignId}

Delete acquisition campaign

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

Path parameters

Name	Type	Description
`campaignId` required	`Id`

Responses

Status	Returns	Description
`204`		Campaign deleted (no content).
`401`	`ErrorResponse`	Authentication failed
`404`	`ErrorResponse`	Campaign not found

Example request

curl -X DELETE https://api.simplyrcs.com/acquisition-campaigns/{campaignId} \
  -H 'Authorization: Bearer YOUR_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

Name	Type	Description
`campaignId` required	`Id`

Responses

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

Example request

curl -X POST https://api.simplyrcs.com/acquisition-campaigns/{campaignId}/generate-qr \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

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

Name	Type	Description
`campaignId` required	`Id`

Request body

AcquisitionEnrollRequest · optional

Responses

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

Example request

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

Other parts of the API

Get a free sender ID test Read the RCS API guide