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

Blasts API

The SimplyRCS blasts 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.

Campaign creation, audience selection, launch, and progress tracking.

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

GET/v1/blasts

List blasts

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

Query parameters

NameTypeRequiredDescription
pageintegerNo
limitintegerNo
status"DRAFT" | "SCHEDULED" | "SENDING" | "DISPATCHED" | "SENT" | "FAILED"No

Responses

StatusReturnsDescription
200BlastListResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

POST/v1/blasts

Create a blast

Creates a DRAFT blast. Provide exactly one content source (botId, contentJson, or variants), and at least one of segmentId or contactIds.

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

Request body

BlastCreateRequest · optional

FieldTypeRequiredDescription
namestringYes
channelIdstringYes
senderIdIdstringNo
protocolTypestringNoRequires senderIdId when set.
segmentIdstringNo
contactIdsstring[]No
botIdstringNoExactly one content source: botId, contentJson, or variants.
fallbackChannelIdsstring[]No
contentJsonstringNoExactly one content source: botId, contentJson, or variants.
variantsarrayNoA/B test arms (≥2). Recipients are split across arms and each sends its arm's content instead of contentJson.
recurringConfigstringNoWhen set, the blast recurs; the scheduler clones the next occurrence each time it fires.

Responses

StatusReturnsDescription
201BlastSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/blasts \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example name",
    "channelId": "ch_rcs_us",
    "protocolType": "RCS_RICH",
    "botId": "bot_2a9f",
    "contentJson": "example"
  }'

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/blasts/{id}

Get a blast

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

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200BlastDetailSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

PUT/v1/blasts/{id}

Update a blast

Only DRAFT and SCHEDULED blasts can be edited.

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

Path parameters

NameTypeDescription
id requiredstring

Request body

BlastUpdateRequest · optional

FieldTypeRequiredDescription
namestringNo
channelIdstringNo
senderIdIdstringNo
protocolTypestringNo
segmentIdstringNo
contactIdsstring[]No
botIdstringNo
fallbackChannelIdsstring[]No
fallbackConfigarrayNoUp to 3 fallback steps in strictly descending richness (RCS → MMS → SMS).
contentJsonstringNo

Responses

StatusReturnsDescription
200BlastSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X PUT https://api.simplyrcs.com/v1/blasts/{id} \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "protocolType": "RCS_RICH",
    "fallbackConfig": [
      {
        "senderIdId": "snd_7f3a",
        "protocolType": "RCS_RICH",
        "condition": "DELIVERY_FAILED",
        "waitMinutes": 1
      }
    ]
  }'

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/blasts/{id}

Delete a blast

Only DRAFT blasts can be deleted.

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

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
204Blast deleted (no content)
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

PUT/v1/blasts/{id}/content

Update blast content

PUT https://api.simplyrcs.com/v1/blasts/{id}/content · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Request body

BlastContentRequest · optional

FieldTypeRequiredDescription
type"bot" | "custom"Yes
botIdstringNoRequired when type is "bot".
contentstringNoRequired when type is "custom".

Responses

StatusReturnsDescription
200BlastSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X PUT https://api.simplyrcs.com/v1/blasts/{id}/content \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "bot",
    "botId": "bot_2a9f",
    "content": "example"
  }'

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

PUT/v1/blasts/{id}/audience

Update blast audience

PUT https://api.simplyrcs.com/v1/blasts/{id}/audience · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Request body

BlastAudienceRequest · optional

FieldTypeRequiredDescription
type"list" | "segment" | "manual"Yes
listIdstringNoRequired when type is "list".
segmentIdstringNoRequired when type is "segment".
contactIdsstring[]NoRequired when type is "manual".

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X PUT https://api.simplyrcs.com/v1/blasts/{id}/audience \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "list",
    "listId": "lst_3c1d",
    "segmentId": "segmen_01h9",
    "contactIds": [
      "ct_8f21"
    ]
  }'

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/blasts/{id}/estimate

Estimate blast delivery cost

GET https://api.simplyrcs.com/v1/blasts/{id}/estimate · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

POST/v1/blasts/{id}/test

Send a blast test message

POST https://api.simplyrcs.com/v1/blasts/{id}/test · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Request body

BlastTestRequest · optional

FieldTypeRequiredDescription
phoneNumberstringYesE.164 phone number to send the test message to. Max 5 test sends per blast.

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/blasts/{id}/test \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumber": "+14155550142"
  }'

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/blasts/{id}/launch

Launch a blast

Launches a DRAFT blast: schedules it when scheduledAt is in the future, otherwise starts sending immediately.

POST https://api.simplyrcs.com/v1/blasts/{id}/launch · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

GET/v1/blasts/{id}/progress

Get blast progress

GET https://api.simplyrcs.com/v1/blasts/{id}/progress · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200objectSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

POST/v1/blasts/{id}/send

Send a blast immediately

POST https://api.simplyrcs.com/v1/blasts/{id}/send · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200BlastTransitionResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

POST/v1/blasts/{id}/schedule

Schedule a blast

POST https://api.simplyrcs.com/v1/blasts/{id}/schedule · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Request body

BlastScheduleRequest · optional

FieldTypeRequiredDescription
scheduledAtstringYes

Responses

StatusReturnsDescription
200BlastScheduleResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/blasts/{id}/schedule \
  -H "Authorization: Bearer $SIMPLYRCS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "scheduledAt": "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.

POST/v1/blasts/{id}/cancel

Cancel a blast

Cancels a SCHEDULED, SENDING, or DISPATCHED blast.

POST https://api.simplyrcs.com/v1/blasts/{id}/cancel · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200BlastTransitionResponseSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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

GET/v1/blasts/{id}/stats

Get blast statistics

GET https://api.simplyrcs.com/v1/blasts/{id}/stats · requires an API key

Path parameters

NameTypeDescription
id requiredstring

Responses

StatusReturnsDescription
200BlastStatsSuccessful response
400ErrorResponseValidation error
401ErrorResponseAuthentication failed

Example request

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