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

# Update contact

> Update a WhatsApp contact's profile or metadata.



## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml patch /whatsapp/contacts/{identifier}
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: 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}:
    parameters:
      - name: identifier
        in: path
        required: true
        description: Contact UUID or WhatsApp phone number
        schema:
          type: string
        example: 123e4567-e89b-12d3-a456-426614174000
    patch:
      tags:
        - Contacts
      summary: Update contact
      description: Update a WhatsApp contact's profile or metadata.
      operationId: updateWhatsappContactPlatform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  type: object
                  properties:
                    wa_id:
                      type: string
                    profile_name:
                      type: string
                    display_name:
                      type: string
                    customer_id:
                      type: string
                      format: uuid
                    metadata:
                      type: object
                      additionalProperties: true
      responses:
        '200':
          description: Contact updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsappContactResponse'
        '404':
          description: Contact not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    WhatsappContactResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/WhatsappContact'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    WhatsappContact:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique contact ID
          example: 123e4567-e89b-12d3-a456-426614174000
        wa_id:
          type:
            - string
            - 'null'
          description: >-
            WhatsApp ID (E.164 phone number). Can be null when Meta only
            provides BSUID-based identity.
          example: '15551234567'
        business_scoped_user_id:
          type:
            - string
            - 'null'
          description: WhatsApp business-scoped user ID
          example: US.13491208655302741918
        parent_business_scoped_user_id:
          type:
            - string
            - 'null'
          description: Parent business-scoped user ID when provided by Meta
          example: US.ENT.506847293015824
        username:
          type:
            - string
            - 'null'
          description: WhatsApp username when available
          example: '@testusername'
        profile_name:
          type: string
          description: Name as shown on WhatsApp
          example: John Doe
        display_name:
          type: string
          nullable: true
          description: Custom display name set by your app
          example: John (VIP)
        customer_id:
          type: string
          format: uuid
          nullable: true
          description: Associated customer ID
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: Custom key-value data
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````