API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · campaign_items

Campaign Item Schema

Schema-ID
campaign_item
Collection
campaign_items
Permissions
  • Lesencampaign_item_view
  • Anlegencampaign_item_create
  • Änderncampaign_item_edit
  • Löschencampaign_item_delete
Beziehungen

Felder

Campaign Item Schema

campaign_items4 Permissions

A single work item inside a campaign, one per target entity (party/asset/contact/…). Holds status, assignee, snapshot, outcome, linked artefacts and per-action run history.

campaignIduuiderforderlich→ campaign
read-only
targetEntityTypestringerforderlich

Schema id of the target entity (e.g. "party", "asset").

1–64 Zeichenread-only
targetEntityIduuiderforderlich
read-only
snapshotobjectoptional
read-onlynullable
displayNamestringoptional
max 500 Zeichennullable
fieldsobjectoptional
capturedAtdatetimeoptional
resolvedContactobjectoptional
read-onlynullable
contactPartyIduuidoptional
nullable
contactRelationshipIduuidoptional
nullable
emailemailoptional
nullable
functionRolesstring[]optional
Default: []
resolverReasonstringoptional
max 200 Zeichennullable
statusstringerforderlich
Werte
PENDINGIN_PROGRESSDONESKIPPEDFAILEDSKIPPED_NO_RECIPIENTSKIPPED_NO_CONSENTSKIPPED_FREQUENCY_CAPSKIPPED_LEFT_SEGMENTUNSUBSCRIBEDBOUNCEDCOMPLAINED
Default: "PENDING"
statusReasonstringoptional
max 500 Zeichennullable
outcomestringoptional

Type-specific enum (CONVERTED, NOT_INTERESTED, MEETING_BOOKED, UPGRADED, …).

max 100 Zeichennullable
outcomeAtdatetimeoptional
nullable
outcomeByuuidoptional
nullable
outcomeNotesstringoptional
max 2000 Zeichennullable
assigneeUserIduuidoptional
nullable
assigneeTeamIduuidoptional
nullable
dueDatedatetimeoptional
nullable
prioritystringoptional
Werte
LOWNORMALHIGHURGENT
Default: "NORMAL"
notesstringoptional
max 5000 Zeichennullable
linkedEntityRefsobject[]optional
Default: []read-only
schemastringerforderlich
max 64 Zeichenread-only
iduuiderforderlich
createdBystringoptional
Werte
ACTIONMANUAL
Default: "ACTION"read-only
createdAtdatetimeoptional
read-only
actionRunsobject[]optional
Default: []read-only
actionIdstringerforderlich
max 64 Zeichen
actionTypestringerforderlich
max 64 Zeichen
runAtdatetimeerforderlich
statusstringerforderlich
Werte
SUCCESSFAILEDSKIPPED
errorstringoptional
max 2000 Zeichennullable
resultobjectoptional
nullable
variantstringoptional
Werte
AB
nullable
emailEventsobject[]optional
Default: []read-only
typestringerforderlich
Werte
SENTDELIVEREDOPENEDCLICKEDBOUNCEDUNSUBSCRIBEDCOMPLAINED
atdatetimeerforderlich
metaobjectoptional
interactionsobject[]optional

Manually logged interactions between a user and the target contact (calls, meetings, notes).

Default: []read-only
iduuiderforderlich
atdatetimeerforderlich
byUserIduuiderforderlich
kindstringerforderlich
Werte
CALLEMAILMEETINGNOTECHATOTHER
directionstringoptional
Werte
INBOUNDOUTBOUNDINTERNALnull
nullable
contactPartyIduuidoptional
nullable
summarystringoptional
max 2000 Zeichennullable
outcomestringoptional
max 100 Zeichennullable
uniqueKeystringoptional

Dedup key: campaignId + targetEntityType + targetEntityId (+ contactRelationshipId if sendToAllMatching).

max 500 Zeichenread-only
resendCountintegeroptional

Number of manual re-executions via /resend. Mixed into the action correlationId so the send-email Redis dedup (24h TTL) does not swallow the re-send.

≥ 0Default: 0
enteredAtdatetimeoptional

When the item entered the campaign (= createdAt normally).

read-only

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/campaign_items — Liste, paginiert + filterbar
  • GET /api/v1/campaign_items/<id> — Einzelne Entity
  • POST /api/v1/campaign_items — Anlegen
  • PATCH /api/v1/campaign_items/<id> — Teil-Update
  • DELETE /api/v1/campaign_items/<id> — Soft-Delete
  • GET /api/v1/campaign_items/<id>/timeline — Audit + Aktivitäten

Suche