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

# List marketing preferences

> List the contact's marketing message preference on each of your WhatsApp
numbers. One entry per number the contact has stopped or resumed
marketing on; an empty list means the contact never changed their
preference and is subscribed everywhere.

Preferences are read-only. Only the contact can change them, inside
WhatsApp. While a preference is `stopped`, marketing template sends to
the contact on that number are refused with error code
`marketing_preference_stopped`.




## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /whatsapp/contacts/{identifier}/marketing_preferences
openapi: 3.1.0
info:
  title: Kapso Platform API
  version: 0.2.0
  description: >
    Build WhatsApp messaging into your product. Manage customers, connect phone
    numbers, send broadcasts, and handle conversations.
servers:
  - url: https://api.kapso.ai/platform/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Customers
    description: Manage customer accounts
  - name: Setup Links
    description: WhatsApp onboarding via embedded signup
  - name: Phone Numbers
    description: Connect and manage WhatsApp numbers
  - name: Webhooks
    description: Subscribe to WhatsApp events
  - name: Display Names
    description: Update WhatsApp business display names
  - name: Broadcasts
    description: |
      Send template messages at scale

      **Alpha**: This API is in alpha and subject to change
  - name: Conversations
    description: Manage conversation state
  - name: Media
    description: Upload media files for WhatsApp messaging
  - name: Users
    description: Manage project team members
  - name: Inbox Embeds
    description: Create and manage embeddable inbox access links
  - name: Webhook Deliveries
    description: View webhook delivery attempts and their status
  - name: External API Logs
    description: View logs of external API calls made by the project
  - name: Log Search
    description: Search log events across API, Meta, workflow, and webhook sources
  - name: Events
    description: Emit and query project-scoped events
  - name: Provider Models
    description: List available AI provider models
  - name: WhatsApp Flows
    description: Build interactive WhatsApp Flows for surveys and forms
  - name: Contacts
    description: Manage WhatsApp contacts
paths:
  /whatsapp/contacts/{identifier}/marketing_preferences:
    parameters:
      - name: identifier
        in: path
        required: true
        description: Contact UUID or WhatsApp phone number
        schema:
          type: string
        example: '15551234567'
    get:
      tags:
        - Contacts
      summary: List marketing preferences
      description: |
        List the contact's marketing message preference on each of your WhatsApp
        numbers. One entry per number the contact has stopped or resumed
        marketing on; an empty list means the contact never changed their
        preference and is subscribed everywhere.

        Preferences are read-only. Only the contact can change them, inside
        WhatsApp. While a preference is `stopped`, marketing template sends to
        the contact on that number are refused with error code
        `marketing_preference_stopped`.
      operationId: listWhatsappContactMarketingPreferences
      responses:
        '200':
          description: Marketing preferences retrieved
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/WhatsappContactMarketingPreferenceListResponse
        '404':
          description: Contact not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    WhatsappContactMarketingPreferenceListResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhatsappContactMarketingPreference'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    WhatsappContactMarketingPreference:
      type: object
      description: >-
        A contact's marketing message preference on one of your WhatsApp
        numbers. Recorded when the contact stops or resumes marketing messages
        inside WhatsApp. Read-only — only the contact can change it.
      properties:
        id:
          type: string
          description: Meta phone number ID of the number the preference applies to
          example: '123456789012345'
        phone_number_id:
          type: string
          description: Meta phone number ID (same as `id`)
          example: '123456789012345'
        status:
          type: string
          enum:
            - stopped
            - resumed
          description: >-
            Current preference. `stopped` blocks marketing template sends to
            this contact on this number.
        detail:
          type:
            - string
            - 'null'
          description: Free-text reason reported by Meta
          example: User requested to stop marketing messages
        source:
          type: string
          description: How the preference was captured
          example: meta_webhook
        marketing_allowed:
          type: boolean
          description: >-
            Whether marketing template sends are allowed. `false` when `status`
            is `stopped`.
        config_display_name:
          type:
            - string
            - 'null'
          description: Display name of the WhatsApp number
        last_event_at:
          type: string
          format: date-time
          description: Timestamp WhatsApp reported for the latest preference change
        whatsapp_contact_id:
          type: string
          format: uuid
        internal_id:
          type: string
          format: uuid
          description: Internal ID of the preference record
        whatsapp_config_id:
          type: string
          format: uuid
          description: Internal ID of the WhatsApp number's configuration
        whatsapp_config_internal_id:
          type: string
          format: uuid
          description: Same as `whatsapp_config_id`
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````