Campaigns
Alle Operationen rund um Campaigns.
Datenmodell
Die Endpoints dieses Moduls arbeiten auf folgender Entität. Die Schema-Referenz listet jedes Feld mit Typ, Validierung und Beziehungen:
| Entität | Schema-ID | Felder | Sequenz | Permissions |
|---|---|---|---|---|
| Campaign | campaign |
30 | — | campaign_* |
Endpoints
| Methode | Pfad | Operation | Beschreibung |
|---|---|---|---|
POST |
/v1/campaigns |
Create campaign | Create a new campaign in the active tenant. |
DELETE |
/v1/campaigns/{id} |
Delete campaign | Soft delete entity. |
GET |
/v1/campaigns/{id} |
Get campaign by id | Fetch a single campaign. |
GET |
/v1/campaigns/{id}/linked |
Get linked entities | CodeMeta OS API endpoint. |
GET |
/v1/campaigns/{id}/tasks |
GET /v1/campaigns/{id}/tasks | List all tasks linked to this campaign. |
GET |
/v1/campaigns/{id}/timeline |
Get timeline | CodeMeta OS API endpoint. |
GET |
/v1/campaigns/{id}/transitions |
List transitions | CodeMeta OS API endpoint. |
GET |
/v1/campaigns |
List campaigns | List campaigns for the active tenant. |
PATCH |
/v1/campaigns/{id} |
Patch campaign | JSON Merge Patch update. |
PATCH |
/v1/campaigns/{id}/items/{itemId}/assignment |
PATCH /v1/campaigns/{id}/items/{itemId}/assignment | Update mutable workflow fields on a campaign item: assignee, outcome, notes and priority. |
POST |
/v1/campaigns/{id}/actions/{actionId}/test-email |
POST /v1/campaigns/{id}/actions/{actionId}/test-email | Send a one-off test e-mail using the rendered SEND_EMAIL action body. |
POST |
/v1/campaigns/{id}/approve |
POST /v1/campaigns/{id}/approve | Approve a campaign that requires approval before start. |
POST |
/v1/campaigns/bulk |
Bulk operation | CodeMeta OS API endpoint. |
POST |
/v1/campaigns/{id}/complete |
POST /v1/campaigns/{id}/complete | Force-complete a campaign. |
POST |
/v1/campaigns/{id}/items/bulk-assign |
POST /v1/campaigns/{id}/items/bulk-assign | Bulk-assign campaign items to a user or team. |
POST |
/v1/campaigns/{id}/items/bulk-resend |
POST /v1/campaigns/{id}/items/bulk-resend | Bulk-reset items to PENDING and enqueue PROCESS_ITEM for each (max 200 IDs per call). |
POST |
/v1/campaigns/{id}/items/bulk-skip |
POST /v1/campaigns/{id}/items/bulk-skip | Bulk-skip campaign items (max 500 IDs per call). |
POST |
/v1/campaigns/{id}/items/bulk-status |
POST /v1/campaigns/{id}/items/bulk-status | Bulk status/outcome update. |
POST |
/v1/campaigns/{id}/items/{itemId}/interactions |
POST /v1/campaigns/{id}/items/{itemId}/interactions | Append a manually logged interaction (call/meeting/note) to a campaign item. |
POST |
/v1/campaigns/{id}/items/{itemId}/resend |
POST /v1/campaigns/{id}/items/{itemId}/resend | Re-execute all actions for a campaign item: clears actionRuns, resets status to PENDING, enqueues PROCESS_ITEM. |
POST |
/v1/campaigns/{id}/items/{itemId}/run-action |
POST /v1/campaigns/{id}/items/{itemId}/run-action | Manually run one action of a campaign on a specific item. |
POST |
/v1/campaigns/{id}/items/{itemId}/skip |
POST /v1/campaigns/{id}/items/{itemId}/skip | Manually skip a campaign item. |
POST |
/v1/campaigns/{id}/pause |
POST /v1/campaigns/{id}/pause | Pause a running campaign. |
POST |
/v1/campaigns/{id}/preflight |
POST /v1/campaigns/{id}/preflight | Pre-start validation: segment count, recipient resolution on a sample, action config. |
POST |
/v1/campaigns/{id}/preview |
POST /v1/campaigns/{id}/preview | Evaluate a campaign segment without creating items — returns count + sample. |
POST |
/v1/campaigns/{id}/refresh-segment |
POST /v1/campaigns/{id}/refresh-segment | Trigger a manual segment re-evaluation (for DYNAMIC segments). |
POST |
/v1/campaigns/{id}/resume |
POST /v1/campaigns/{id}/resume | Resume a paused campaign. |
POST |
/v1/campaigns/{id}/start |
POST /v1/campaigns/{id}/start | Transition campaign to RUNNING and enqueue segment evaluation. |
POST |
/v1/campaigns/{id}/transition |
POST /v1/campaigns/{id}/transition | CodeMeta OS API endpoint. |
POST |
/v1/campaigns/{id}/transitions/{transitionKey} |
Execute transition | CodeMeta OS API endpoint. |
POST |
/v1/campaigns/{id}/unapprove |
POST /v1/campaigns/{id}/unapprove | Revoke an existing campaign approval. |
PUT |
/v1/campaigns/{id} |
Replace campaign | Full replace with optimistic locking. |