> ## 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.

# Create or update the preference-center configuration

> Create or replace this tenant's hosted preference-center configuration — the branding (company name, logo, colours, header/footer copy), the channels a contact may manage, the subscription topics, and the optional post-opt-out redirect. Call it from the compliance settings screen whenever an operator saves the setup; the stored config drives the public hosted page a contact opens from an unsubscribe link. Owner/admin only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/compliance/preference-center
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/compliance/preference-center:
    post:
      tags:
        - Compliance
      summary: Create or update the preference-center configuration
      description: >-
        Create or replace this tenant's hosted preference-center configuration —
        the branding (company name, logo, colours, header/footer copy), the
        channels a contact may manage, the subscription topics, and the optional
        post-opt-out redirect. Call it from the compliance settings screen
        whenever an operator saves the setup; the stored config drives the
        public hosted page a contact opens from an unsubscribe link. Owner/admin
        only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - companyName
              properties:
                enabled:
                  type: boolean
                  default: true
                  description: Whether the hosted preference page is live.
                companyName:
                  type: string
                  description: Name shown on the hosted page.
                logoUrl:
                  type: string
                  description: Logo image URL (http/https only).
                primaryColor:
                  type: string
                  description: Brand colour as a 6-digit hex value (e.g. `#2563eb`).
                headerText:
                  type: string
                  description: Heading shown at the top of the page.
                footerText:
                  type: string
                  description: Footer copy shown beneath the preferences.
                channels:
                  type: array
                  description: Channels a contact can opt in or out of.
                  items:
                    type: string
                showFrequencyOptions:
                  type: boolean
                  description: Whether to show the send-frequency selector.
                showGdprDelete:
                  type: boolean
                  description: Whether to offer the "delete my data" action.
                redirectUrl:
                  type: string
                  description: Optional URL to redirect to after opt-out (http/https only).
                topics:
                  type: array
                  description: Subscription topics/groups the contact can manage.
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Stable lowercase slug for the topic.
                      name:
                        type: string
                      description:
                        type: string
                      defaultOptIn:
                        type: boolean
            example:
              companyName: Acme Corp
              primaryColor: '#2563eb'
              headerText: Communication Preferences
              channels:
                - sms
                - email
              showFrequencyOptions: true
              showGdprDelete: true
              topics:
                - id: product-updates
                  name: Product updates
                  defaultOptIn: true
      responses:
        '201':
          description: The saved preference-center configuration.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: The stored preference-center configuration.
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  enabled: true
                  companyName: Acme Corp
                  primaryColor: '#2563eb'
                  channels:
                    - sms
                    - email
                  topics:
                    - id: product-updates
                      name: Product updates
                      defaultOptIn: true
                meta:
                  request_id: req_1a2b3c4d5e6f
                  timestamp: '2026-08-07T12:00:00.000Z'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  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_*)

````