Blasts API

GET/v1/blasts

List blasts

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

Query parameters

Responses

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

Responses

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 request" }'

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

GET/v1/blasts/{id}

Get a blast

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

Path parameters

Responses

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

Request body

BlastUpdateRequest · optional

Responses

Example request

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

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

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

Responses

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

Request body

BlastContentRequest · optional

Responses

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 '{ "name": "Example request" }'

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

PUT/v1/blasts/{id}/audience

Update blast audience

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

Path parameters

Request body

BlastAudienceRequest · optional

Responses

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 '{ "name": "Example request" }'

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

GET/v1/blasts/{id}/estimate

Estimate blast delivery cost

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

Path parameters

Responses

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

Request body

BlastTestRequest · optional

Responses

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 '{ "name": "Example request" }'

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

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

Responses

Example request

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

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

GET/v1/blasts/{id}/progress

Get blast progress

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

Path parameters

Responses

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

Responses

Example request

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

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

POST/v1/blasts/{id}/schedule

Schedule a blast

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

Path parameters

Request body

BlastScheduleRequest · optional

Responses

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 '{ "name": "Example request" }'

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

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

Responses

Example request

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

The body in this sample is the spec’s placeholder, not a real payload: send the request body type named above with the fields for this operation.

GET/v1/blasts/{id}/stats

Get blast statistics

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

Path parameters

Responses

Example request

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