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

Marketing Consent Schema

Schema-ID
marketing_consent
Collection
marketing_consents
Permissions
  • Lesenmarketing_consent_view
  • Anlegenmarketing_consent_create
  • Ändernmarketing_consent_edit
  • Löschenmarketing_consent_delete

Felder

Marketing Consent Schema

marketing_consents4 Permissions

Per-(person × org × category × channel) marketing consent with double-opt-in lifecycle (ADR 0290).

personPartyIduuiderforderlich

ID of the PERSON party the consent belongs to.

organizationPartyIduuidoptional

ID of the ORGANIZATION party the person relates to (the consent is scoped to the work context). Null for a person without an org relationship.

nullable
contactRelationshipIduuidoptional

ID of the party_relationship whose marketingConsent cache is recomputed from this record.

nullable
categorystringerforderlich
Werte
NEWSLETTERPRODUCT_UPDATESSALES_OUTREACHEVENTSSURVEYS
channelstringerforderlich
Werte
EMAIL
Default: "EMAIL"
statusstringerforderlich
Werte
PENDINGGRANTEDREVOKEDEXPIRED
Default: "PENDING"
legalBasisstringoptional
Werte
CONSENTLEGITIMATE_INTERESTEXISTING_CUSTOMER
Default: "CONSENT"nullable
sourcestringoptional
Werte
WEB_FORMSALES_MANUALPHONECONTRACTIMPORTSYSTEM
nullable
initiatedByUserIduuidoptional

User who initiated the sign-up (e.g. the salesperson).

nullable
emailstringoptional

Email the consent was captured for (denormalized for the DOI mail + audit).

max 320 Zeichennullable
consentTextstringoptional

Exact wording the person agreed to (accountability).

max 4000 Zeichennullable
consentTextVersionstringoptional
max 64 Zeichennullable
doiTokenstringoptional

Opaque single-use confirmation token; cleared on confirm/expiry.

max 128 Zeichenread-onlynullable
doiSentAtdatetimeoptional
read-onlynullable
doiExpiresAtdatetimeoptional
read-onlynullable
confirmedAtdatetimeoptional
read-onlynullable
proofIpstringoptional

Client IP recorded at the PENDING → GRANTED transition.

max 64 Zeichenread-onlynullable
proofUserAgentstringoptional
max 512 Zeichenread-onlynullable
revokedAtdatetimeoptional
read-onlynullable
revokedReasonstringoptional
max 500 Zeichennullable
notesstringoptional
max 1000 Zeichennullable

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

Suche