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

# Sync Contacts

> Initiate contact sync from WhatsApp account.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/contacts/sync
openapi: 3.1.0
info:
  title: wazzapi Public API
  description: >-
    Public API surface for external API-key clients. Only stable /api/v1
    endpoints are included.


    ## Webhook deliveries

    This reference also includes the webhook requests Wazzapi sends to your
    endpoint for incoming messages, message status updates, and device status
    changes. See the `Incoming webhooks` section in the sidebar for headers,
    payload fields, and concrete examples.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Incoming webhooks
    description: >-
      POST deliveries that Wazzapi sends to your webhook endpoint after you
      subscribe to supported events. Verify the signature against the raw body
      and return a 2xx response quickly.
paths:
  /api/v1/contacts/sync:
    post:
      tags:
        - contacts
      summary: Sync Contacts
      description: Initiate contact sync from WhatsApp account.
      operationId: sync_contacts_api_v1_contacts_sync_post
      parameters:
        - name: Authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactSyncRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactSyncResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ContactSyncRequest:
      properties:
        whatsapp_account_id:
          type: string
          format: uuid
          title: Whatsapp Account Id
        sync_type:
          type: string
          title: Sync Type
          default: full
      type: object
      required:
        - whatsapp_account_id
      title: ContactSyncRequest
      description: Request to sync contacts from WhatsApp.
    ContactSyncResponse:
      properties:
        success:
          type: boolean
          title: Success
        job_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Id
        message:
          type: string
          title: Message
        status:
          type: string
          title: Status
          default: pending
      type: object
      required:
        - success
        - message
      title: ContactSyncResponse
      description: Response from contact sync initiation.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````