A valid request URL is required to generate request examples{
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"trigger_kind": "one_shot",
"event_type": "<string>",
"date_attribute": "<string>",
"date_offset_days": 123,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"frequency_cap_days": 123,
"activated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"system_key": "<string>",
"system": true,
"claimed": 123,
"steps": [
{
"position": 123,
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offset_hours": 123
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Arm a campaign
Requires messaging:manage, and the plan has to include outbound campaigns. This is the only place the plan is consulted: writing a campaign, composing its templates and previewing them are free, and so is every read here — a downgrade must not hide a campaign somebody needs to be able to pause.
On a one-shot this also materialises the audience: everybody in the segment right now becomes a claimed send, written to disk before anything leaves. That is what makes a blast resumable — a worker that dies at recipient 4,312 continues at 4,313, because 4,313 is already a row. The answer carries claimed, which is how many people this is going to reach.
Arming a campaign that is already armed answers 409: the transition is decided by the statement rather than by a check, so “already active” is not an act.
Arming again after a pause is a new occasion for a one-shot — it will reach whoever is in the audience now, including people it reached before, subject to the frequency cap and the global cooldown.
A valid request URL is required to generate request examples{
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"trigger_kind": "one_shot",
"event_type": "<string>",
"date_attribute": "<string>",
"date_offset_days": 123,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"frequency_cap_days": 123,
"activated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"system_key": "<string>",
"system": true,
"claimed": 123,
"steps": [
{
"position": 123,
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offset_hours": 123
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
Response
The campaign, armed. claimed is present on a one-shot.
An audience, a trigger, a sequence and a cap. Per environment, like everything on the customer plane.
Show child attributes
Show child attributes