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

GET/v1/blasts

List blasts

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

Query parameters

Name	Type	Required
`page`	`integer`	No
`limit`	`integer`	No
`status`	`"DRAFT" \| "SCHEDULED" \| "SENDING" \| "DISPATCHED" \| "SENT" \| "FAILED"`	No

Responses

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

Example request

curl -X GET https://api.simplyrcs.com/v1/blasts \
  -H 'Authorization: Bearer YOUR_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

Responses

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

Example request

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

GET/v1/blasts/{id}

Get a blast

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

Path parameters

Name	Type	Description
`id` required	`string`

Responses

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

Example request

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

Name	Type	Description
`id` required	`string`

Request body

BlastUpdateRequest · optional

Responses

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

Example request

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

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

Name	Type	Description
`id` required	`string`

Responses

Status	Returns	Description
`204`		Blast deleted (no content)
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

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

Name	Type	Description
`id` required	`string`

Request body

BlastContentRequest · optional

Responses

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

Example request

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

PUT/v1/blasts/{id}/audience

Update blast audience

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

Path parameters

Name	Type	Description
`id` required	`string`

Request body

BlastAudienceRequest · optional

Responses

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

Example request

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

GET/v1/blasts/{id}/estimate

Estimate blast delivery cost

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

Path parameters

Name	Type	Description
`id` required	`string`

Responses

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

Example request

curl -X GET https://api.simplyrcs.com/v1/blasts/{id}/estimate \
  -H 'Authorization: Bearer YOUR_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

Name	Type	Description
`id` required	`string`

Request body

BlastTestRequest · optional

Responses

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

Example request

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

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

Name	Type	Description
`id` required	`string`

Responses

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

Example request

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

GET/v1/blasts/{id}/progress

Get blast progress

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

Path parameters

Name	Type	Description
`id` required	`string`

Responses

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

Example request

curl -X GET https://api.simplyrcs.com/v1/blasts/{id}/progress \
  -H 'Authorization: Bearer YOUR_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

Name	Type	Description
`id` required	`string`

Responses

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

Example request

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

POST/v1/blasts/{id}/schedule

Schedule a blast

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

Path parameters

Name	Type	Description
`id` required	`string`

Request body

BlastScheduleRequest · optional

Responses

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

Example request

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

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

Name	Type	Description
`id` required	`string`

Responses

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

Example request

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

GET/v1/blasts/{id}/stats

Get blast statistics

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

Path parameters

Name	Type	Description
`id` required	`string`

Responses

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

Example request

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

Other parts of the API

Get a free sender ID test Read the RCS API guide