> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Record a consent decision

> Append an immutable consent decision (grant, revoke, or right-to-be-forgotten erasure) to the tenant's consent ledger for one identity and processing purpose. Call this from a cookie-banner or preference-center integration whenever a data subject changes their consent; the destination fan-out worker reads the ledger via the consent-check endpoint before activating events to a purpose-scoped destination.



## OpenAPI

````yaml /openapi.yaml post /api/v1/cdp/consent
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/cdp/consent:
    post:
      tags:
        - CDP
      summary: Record a consent decision
      description: >-
        Append an immutable consent decision (grant, revoke, or
        right-to-be-forgotten erasure) to the tenant's consent ledger for one
        identity and processing purpose. Call this from a cookie-banner or
        preference-center integration whenever a data subject changes their
        consent; the destination fan-out worker reads the ledger via the
        consent-check endpoint before activating events to a purpose-scoped
        destination.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - identity_kind
                - identity_value
                - action
              properties:
                identity_kind:
                  type: string
                  enum:
                    - anonymous_id
                    - user_id
                    - contact_id
                  description: Identity namespace that `identity_value` belongs to.
                identity_value:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: >-
                    The identity the decision applies to (contact id,
                    authenticated user id, or anonymous device id).
                purpose:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: >-
                    Processing purpose the decision scopes to (e.g.
                    `marketing_email`). Required for `grant`/`revoke`; omit for
                    `rtbf`, which revokes every purpose.
                action:
                  type: string
                  enum:
                    - grant
                    - revoke
                    - rtbf
                  description: >-
                    Consent verb. `rtbf` (right-to-be-forgotten) revokes all
                    purposes and triggers downstream erasure propagation.
                lawful_basis:
                  type: string
                  enum:
                    - consent
                    - contract
                    - legal_obligation
                    - vital_interests
                    - public_task
                    - legitimate_interests
                  description: GDPR Article 6 lawful basis, recorded for audit.
                consent_text_version:
                  type: string
                  description: Version tag of the consent copy the subject agreed to.
                proof_url:
                  type: string
                  description: HTTPS or `gs://` pointer to captured proof of consent.
                source:
                  type: string
                  description: >-
                    Origin of the decision (e.g. `cookie_banner`,
                    `preference_center`).
                occurred_at:
                  type: string
                  format: date-time
                  description: >-
                    When the subject made the decision. Defaults to receipt
                    time.
                idempotency_key:
                  type: string
                  description: >-
                    De-dupes a replayed banner submission; a repeat returns the
                    original row flagged `deduped=true`.
            example:
              identity_kind: contact_id
              identity_value: cont_01H9XABC1234
              purpose: marketing_email
              action: grant
              lawful_basis: consent
              consent_text_version: '2026-05-01'
              source: preference_center
      responses:
        '200':
          description: The recorded (or de-duplicated) consent ledger entry.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Ledger row id of the recorded decision.
                      deduped:
                        type: boolean
                        description: >-
                          True when an idempotency key matched an existing row
                          and no new decision was written.
                      action:
                        type: string
                        enum:
                          - grant
                          - revoke
                          - rtbf
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  id: cnslgr_01H9XDEF5678
                  deduped: false
                  action: grant
                meta:
                  request_id: req_01H9XREQ0001
                  timestamp: '2026-08-03T12:00:00.000Z'
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````