Scope blast-campaigns:read for reads · blast-campaigns:write for changes
Operations
| GET | /v1/blast-campaigns | List — see list |
| POST | /v1/blast-campaigns | Create — see create |
| GET | /v1/blast-campaigns/{id} | Read — see get |
| PATCH | /v1/blast-campaigns/{id} | Update — see update |
| DELETE | /v1/blast-campaigns/{id} | Delete — see delete |
Minimal create
curl -X POST https://api2.djcsystem.com/v1/blast-campaigns \
-H "Authorization: Bearer $DJC_TOKEN" -H "Content-Type: application/json" \
-d '{ "name": "…" }'Fields
Fields you may send on create. Updatable marks fields accepted by PATCH. Anything not listed is server-owned or hidden.
| Field | Type | On create | Updatable |
|---|---|---|---|
name | string | required | yes |
description | string | optional | yes |
status | enum(new|completed|in progress|paused) | optional | yes |
message | string | optional | yes |
messageList | array<object> | optional | yes |
timeZone | string | optional | yes |
frequency | enum(random|1|2|3|4|15|30) | optional | yes |
offHours | array<object> | optional | yes |
Filters & sorting
| Filterable | status |
| Sortable | date |
| Default order | date:desc |
Child: contacts
Recipients of this campaign (read-only).
| GET | /v1/blast-campaigns/{id}/contacts |
Good to know
- Create the campaign here, then let the user pick recipients and start it in the app; sending is intentionally not exposed.