POST/v1/events
Create an event-triggered message
POST https://api.simplyrcs.com/v1/events · requires an API key
Request body
EventTriggerRequest · optional
| Field | Type | Required | Description |
|---|
event_type | string | Yes | |
data | object | Yes | |
channel | "RCS" | "SMS" | "MMS" | "WHATSAPP" | No | |
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 $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
| Field | Type | Required | Description |
|---|
events | EventTriggerRequest[] | Yes | |
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 $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
| Name | Type | Description |
|---|
campaignId required | Id | |
Request body
AcquisitionEnrollRequest · optional
| Field | Type | Required | Description |
|---|
phone | string | Yes | E.164 phone number. |
firstName | string | No | |
lastName | string | No | |
email | string | No | |
metadata | object | No | |
channelId | string | No | |
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 $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
| 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 $SIMPLYRCS_API_KEY"
POST/acquisition-campaigns
Create acquisition campaign
POST https://api.simplyrcs.com/acquisition-campaigns · requires an API key
Request body
AcquisitionCampaignCreateRequest · optional
| Field | Type | Required | Description |
|---|
name | string | Yes | |
listId | Id | Yes | |
type | AcquisitionCampaignType | Yes | |
keyword | string | No | Required for KEYWORD campaigns. |
shortcode | string | No | Required for KEYWORD campaigns. |
welcomeMessage | string | No | |
doubleOptIn | boolean | No | |
confirmationMessage | string | No | |
webFormConfig | object | No | Only for WEB_FORM and QR_CODE campaigns. |
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 $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
| 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 $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
| Name | Type | Description |
|---|
campaignId required | Id | |
Request body
AcquisitionCampaignUpdateRequest · optional
| Field | Type | Required | Description |
|---|
name | string | No | |
welcomeMessage | string | No | |
doubleOptIn | boolean | No | |
confirmationMessage | string | No | |
status | AcquisitionCampaignStatus | No | |
webFormConfig | object | No | |
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 $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
| 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 $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
| 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 $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
| Name | Type | Description |
|---|
campaignId required | Id | |
Request body
AcquisitionEnrollRequest · optional
| Field | Type | Required | Description |
|---|
phone | string | Yes | E.164 phone number. |
firstName | string | No | |
lastName | string | No | |
email | string | No | |
metadata | object | No | |
channelId | string | No | |
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 '{
"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.