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

# Validate an SMS or WhatsApp survey delivery

> Returns channel readiness, consent or template requirements, the final message, and an attributed survey URL. This endpoint does not send a message.



## OpenAPI

````yaml /openapi.yaml post /workspaces/{workspace}/surveys/{survey}/distribution-preview
openapi: 3.1.0
info:
  title: Contact Button API
  version: 1.0.0-alpha.1
  description: >
    API-first management and public agent actions for Contact Buttons and
    button.contact pages.

    API v1 is the first public contract. Existing private legacy API and browser
    workflows remain supported.
  contact:
    name: Contact Button
    url: https://learn.contactbutton.com
servers:
  - url: https://api.contactbutton.com/v1
    description: Production (canonical)
  - url: https://app.contactbutton.com/v1
    description: Backwards-compatible application-domain alias
security:
  - bearerAuth: []
tags:
  - name: Onboarding
    description: Human-verified agent onboarding.
  - name: Workspaces
  - name: Team
  - name: Pages
  - name: Domains
  - name: Buttons
  - name: Forms
  - name: Surveys
  - name: Apps
  - name: Knowledge
  - name: Booking
  - name: Telephony
    description: >-
      Bring-your-own-Telnyx setup, call flows, phone numbers, and voice
      interactions.
  - name: Reviews
    description: >-
      Send consented review requests through workspace-owned email, SMS, and
      WhatsApp channels.
  - name: Commerce
  - name: Engagement inbox
  - name: Public actions
    description: Public, rate-limited actions that may require human confirmation.
paths:
  /workspaces/{workspace}/surveys/{survey}/distribution-preview:
    post:
      tags:
        - Surveys
      summary: Validate an SMS or WhatsApp survey delivery
      description: >-
        Returns channel readiness, consent or template requirements, the final
        message, and an attributed survey URL. This endpoint does not send a
        message.
      operationId: previewSurveyDistribution
      parameters:
        - $ref: '#/components/parameters/WorkspaceId'
        - name: survey
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SurveyDistributionInput'
      responses:
        '200':
          $ref: '#/components/responses/Data'
        '422':
          $ref: '#/components/responses/Problem'
components:
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
        format: uuid
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: Stable 8–120 character key for safe mutation retries.
      schema:
        type: string
        minLength: 8
        maxLength: 120
  schemas:
    SurveyDistributionInput:
      type: object
      required:
        - channel
        - recipient
        - consent
      properties:
        channel:
          type: string
          enum:
            - sms
            - whatsapp
        recipient:
          type: string
          pattern: ^\+[1-9][0-9]{7,14}$
        locale:
          type: string
          default: en
        template_reference:
          type: string
          description: Required for WhatsApp Business delivery.
        message:
          type: string
          maxLength: 1000
        scheduled_at:
          type: string
          format: date-time
        consent:
          type: object
          required:
            - granted
          properties:
            granted:
              type: boolean
            captured_at:
              type: string
              format: date-time
            source:
              type: string
    DataResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          type: object
          properties:
            request_id:
              type: string
            next_cursor:
              type:
                - string
                - 'null'
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - detail
        - instance
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Data:
      description: Successful data envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DataResponse'
    Problem:
      description: RFC 9457-style problem details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum personal access token
      description: >
        A Contact Button scoped bearer key. Send `Authorization: Bearer
        <token>`.

        Token abilities are enforced independently of workspace membership; both
        checks must pass.

        OAuth 2.0 authorization-code flows are not currently available.
      x-contact-button-token-abilities:
        workspaces:read: Read workspaces, teams, domains, settings, and connections.
        workspaces:write: >-
          Create and manage workspaces, teams, domains, settings, and
          connections.
        content:read: Read buttons, forms, lists, pages, booking types, and knowledge.
        content:write: Create, update, publish, and remove content.
        engagements:read: >-
          Read submissions, subscribers, bookings, callbacks, calls, reviews,
          and conversations.
        engagements:manage: Reply to and manage engagement records.
        actions:request: Request protected actions that can still require human confirmation.

````

## Related topics

- [Surveys](/guides/surveys.md)
- [List email, SMS, and WhatsApp review requests](/api-reference/reviews/list-email-sms-and-whatsapp-review-requests.md)
- [Rollout and rollback](/guides/rollout.md)
- [Reviews](/guides/reviews.md)
- [List WhatsApp templates](/api-reference/engagement-inbox/list-whatsapp-templates.md)