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

# Submit display name request

> Request a display name change. Meta reviews most changes within 24-48 hours. Some names may be approved instantly.




## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml post /whatsapp/phone_numbers/{phone_number_id}/display_name_requests
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 Logs V2 events across API, Meta, workflow, and webhook sources
  - 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/phone_numbers/{phone_number_id}/display_name_requests:
    parameters:
      - name: phone_number_id
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
        - Display Names
      summary: Submit display name request
      description: >
        Request a display name change. Meta reviews most changes within 24-48
        hours. Some names may be approved instantly.
      operationId: createWhatsappDisplayNameRequest
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhatsappDisplayNameRequestCreate'
            examples:
              basic:
                summary: Business name
                value:
                  display_name_request:
                    new_display_name: Acme Support
              instant:
                summary: Instant approval scenario
                value:
                  display_name_request:
                    new_display_name: Bella's Boutique
      responses:
        '201':
          description: Display name request submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsappDisplayNameRequestResponse'
              examples:
                pending:
                  summary: Awaiting Meta review
                  value:
                    data:
                      id: 2b0f4a1e-7a58-4a15-b0c9-0d7f1a2b3c4d
                      phone_number_id: '1234567890'
                      requested_display_name: Acme Support
                      previous_display_name: +1 555-123-4567
                      status: pending_review
                      submitted_at: '2025-07-14T15:00:00Z'
                      reviewed_at: null
                      applied_at: null
                      meta_error_code: null
                      meta_error_subcode: null
                      meta_error_type: null
                      meta_error_message: null
                instant:
                  summary: Approved instantly
                  value:
                    data:
                      id: 9d0e1f2a-3b4c-5d6e-7f8a-9b0c1d2e3f4a
                      phone_number_id: '1234567890'
                      requested_display_name: Bella's Boutique
                      previous_display_name: +1 555-987-6543
                      status: available_without_review
                      submitted_at: '2025-07-20T14:30:00Z'
                      reviewed_at: null
                      applied_at: null
                      meta_error_code: null
                      meta_error_subcode: null
                      meta_error_type: null
                      meta_error_message: null
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    WhatsappDisplayNameRequestCreate:
      type: object
      required:
        - display_name_request
      properties:
        display_name_request:
          type: object
          required:
            - new_display_name
          properties:
            new_display_name:
              type: string
              description: Display name to request (max 256 chars)
    WhatsappDisplayNameRequestResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/WhatsappDisplayNameRequest'
    WhatsappDisplayNameRequest:
      type: object
      required:
        - id
        - requested_display_name
        - status
        - submitted_at
      properties:
        id:
          type: string
          format: uuid
        phone_number_id:
          type:
            - string
            - 'null'
          description: Meta phone number ID
        requested_display_name:
          type: string
        previous_display_name:
          type:
            - string
            - 'null'
          description: Previous display name
        status:
          type: string
          enum:
            - submitted
            - pending_review
            - approved
            - available_without_review
            - deferred
            - declined
            - expired
            - no_review
            - failed
            - applied
            - cancelled
        submitted_at:
          type: string
          format: date-time
        reviewed_at:
          type:
            - string
            - 'null'
          format: date-time
        applied_at:
          type:
            - string
            - 'null'
          format: date-time
        meta_error_code:
          type:
            - integer
            - 'null'
        meta_error_subcode:
          type:
            - integer
            - 'null'
        meta_error_type:
          type:
            - string
            - 'null'
        meta_error_message:
          type:
            - string
            - 'null'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    UnauthorizedError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````