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"
}
}Update a campaign
Requires messaging:manage. Partial: omit a field to leave it alone.
The trigger is replaced whole. Naming trigger_kind replaces the kind and all three operands together; omitting it leaves the whole trigger alone. There is no way to change one operand and keep a kind that no longer matches it, which is the state the database’s own constraint refuses.
steps is replaced as a set when it is present. A sequence is the campaign’s definition of what it says and when, so editing it a row at a time would leave a window in which a live campaign sends half of one sequence and half of another.
status is not here. Arming and holding are their own routes: one of them is gated and both of them are recorded.
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"
}
}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
Body
200one_shot, event, segment_entered, date_offset created_at, first_seen_at, identified_at, email_verified_at, last_seen_at 0 <= x <= 3650 <= x <= 3651 - 10 elementsShow child attributes
Show child attributes
Response
The campaign.
An audience, a trigger, a sequence and a cap. Per environment, like everything on the customer plane.
Show child attributes
Show child attributes