iZap.ai Contacts API

openapi: 3.2.0
info:
  contact:
    email: support@izap.ai
    name: iZap API Support
  description: Public REST API for the iZap WhatsApp business messaging platform.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  title: iZap Contacts API
  version: v1
servers:
- description: Production
  url: https://api.izap.ai
- description: Staging
  url: https://api-staging.izap.ai
tags:
- description: Create, import, list and update business contacts used by chats and template conversations.
  name: Contacts
paths:
  /api/v1/contacts:
    get:
      description: Returns the contacts for the business in the `business-id` header. Use `search` to match by name, phone or email, `chatbot_id` to narrow the list to one assistant, `tag` (repeatable, up to 20) to keep only contacts carrying any of those tags, and `page` / `page_size` to page through the result.
      operationId: listContacts
      parameters:
      - in: query
        name: chatbot_id
        required: false
        schema:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          title: Chatbot Id
      - in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 100
            type: string
          - type: 'null'
          title: Search
      - description: Only contacts carrying any of these tags.
        in: query
        name: tag
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 20
            type: array
          - type: 'null'
          description: Only contacts carrying any of these tags.
          title: Tag
      - in: query
        name: page
        required: false
        schema:
          default: 1
          minimum: 1
          title: Page
          type: integer
      - in: query
        name: page_size
        required: false
        schema:
          default: 20
          maximum: 100
          minimum: 1
          title: Page Size
          type: integer
      - description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
        in: header
        name: business-id
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
          title: Business-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactListOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: List contacts
      tags:
      - Contacts
    post:
      description: Creates a contact for the business in the `business-id` header. The phone number is fixed after creation; use the update operation for the name, email, tags and notes.
      operationId: createContact
      parameters:
      - description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
        in: header
        name: business-id
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
          title: Business-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactCreateIn'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A contact with that phone number already exists for this business.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: Create a contact
      tags:
      - Contacts
  /api/v1/contacts/import:
    post:
      description: Creates or updates contacts from a list of rows for the business in the `business-id` header. Invalid rows are skipped and reported with their 0-based index in the `rows` array; valid rows are still applied.
      operationId: importContacts
      parameters:
      - description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
        in: header
        name: business-id
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
          title: Business-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactImportIn'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactImportOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: Import contacts
      tags:
      - Contacts
  /api/v1/contacts/tags:
    get:
      description: Returns every tag in use on the contacts of the business in the `business-id` header, with how many contacts carry each one, most used first. Tags match exactly, so `VIP` and `vip` are listed apart.
      operationId: listContactTags
      parameters:
      - description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
        in: header
        name: business-id
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
          title: Business-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactTagListOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: List contact tags
      tags:
      - Contacts
  /api/v1/contacts/{contact_id}:
    get:
      description: Returns one contact, including the conversations that belong to it. A contact from another business returns `404` rather than leaking that it exists.
      operationId: getContact
      parameters:
      - in: path
        name: contact_id
        required: true
        schema:
          format: uuid
          title: Contact Id
          type: string
      - description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
        in: header
        name: business-id
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
          title: Business-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactDetailOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: Retrieve a contact
      tags:
      - Contacts
    patch:
      description: Partially updates a contact's name, email, tags or notes. The phone number cannot be changed after the contact is created.
      operationId: updateContact
      parameters:
      - in: path
        name: contact_id
        required: true
        schema:
          format: uuid
          title: Contact Id
          type: string
      - description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
        in: header
        name: business-id
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.
          title: Business-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactUpdateIn'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: Update a contact
      tags:
      - Contacts
components:
  schemas:
    ApiError:
      description: 'The response body of a handled API error.


        ``detail`` is either a plain string (FastAPI''s default for an

        ``HTTPException`` raised with a string, and for the ``default`` fastapi-users

        messages like ``"Not authenticated"``) or the structured

        :class:`ApiErrorDetail` object described above. ``code`` is present only on

        the top-level shape ``aizap.core.exceptions.AppException`` produces for its

        own 5xx responses (``"INTERNAL_ERROR"`` / ``"DB_ERROR"``); it does not

        duplicate the ``code`` nested inside a structured ``detail``.'
      properties:
        code:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          title: Code
        detail:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ApiErrorDetail'
          title: Detail
      required:
      - detail
      title: ApiError
      type: object
    ContactTagOut:
      properties:
        contact_count:
          title: Contact Count
          type: integer
        tag:
          title: Tag
          type: string
      required:
      - tag
      - contact_count
      title: ContactTagOut
      type: object
    ContactImportSkippedOut:
      properties:
        reason:
          enum:
          - invalid_phone
          - duplicate_in_file
          - invalid_email
          title: Reason
          type: string
        row:
          title: Row
          type: integer
      required:
      - row
      - reason
      title: ContactImportSkippedOut
      type: object
    ContactImportOut:
      properties:
        created:
          title: Created
          type: integer
        skipped:
          items:
            $ref: '#/components/schemas/ContactImportSkippedOut'
          title: Skipped
          type: array
        updated:
          title: Updated
          type: integer
      required:
      - created
      - updated
      - skipped
      title: ContactImportOut
      type: object
    ApiErrorDetail:
      additionalProperties: true
      description: 'The structured ``detail`` object some error responses carry.


        Several handlers (the REST API plan gate, the free-tier limits, the

        webhooks entitlement gate, the closed customer-service window) raise

        ``HTTPException(detail={"code": ..., "message": ..., ...})`` — a fixed

        ``code``/``message`` pair plus extra fields specific to that error.

        ``extra="allow"`` keeps those fields in the documented shape instead of

        dropping them.'
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
      required:
      - code
      - message
      title: ApiErrorDetail
      type: object
    ContactListOut:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ContactOut'
          title: Items
          type: array
        page:
          title: Page
          type: integer
        page_size:
          title: Page Size
          type: integer
        total:
          title: Total
          type: integer
      required:
      - items
      - total
      - page
      - page_size
      title: ContactListOut
      type: object
    ContactCreateIn:
      properties:
        email:
          anyOf:
          - format: email
            type: string
          - type: 'null'
          title: Email
        name:
          maxLength: 50
          minLength: 1
          title: Name
          type: string
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        phone_number:
          maxLength: 40
          title: Phone Number
          type: string
        tags:
          items:
            type: string
          title: Tags
          type: array
      required:
      - name
      - phone_number
      title: ContactCreateIn
      type: object
    ContactImportIn:
      properties:
        rows:
          items:
            $ref: '#/components/schemas/ContactImportRowIn'
          title: Rows
          type: array
      required:
      - rows
      title: ContactImportIn
      type: object
    ContactUpdateIn:
      description: Only the fields sent are changed; the phone number is fixed once created.
      properties:
        email:
          anyOf:
          - format: email
            type: string
          - type: 'null'
          title: Email
        name:
          anyOf:
          - maxLength: 50
            minLength: 1
            type: string
          - type: 'null'
          title: Name
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
      title: ContactUpdateIn
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ContactTagListOut:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ContactTagOut'
          title: Items
          type: array
      required:
      - items
      title: ContactTagListOut
      type: object
    ContactImportRowIn:
      properties:
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        phone_number:
          title: Phone Number
          type: string
        tags:
          items:
            type: string
          title: Tags
          type: array
      required:
      - phone_number
      title: ContactImportRowIn
      type: object
    ContactOut:
      properties:
        ai_paused:
          title: Ai Paused
          type: boolean
        conversation_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          title: Conversation Id
        created_at:
          format: date-time
          title: Created At
          type: string
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        id:
          format: uuid
          title: Id
          type: string
        last_interaction_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          title: Last Interaction At
        name:
          title: Name
          type: string
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        opted_out:
          title: Opted Out
          type: boolean
        phone_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone Number
        tags:
          items:
            type: string
          title: Tags
          type: array
      required:
      - id
      - name
      - phone_number
      - email
      - tags
      - notes
      - created_at
      - last_interaction_at
      - conversation_id
      - ai_paused
      - opted_out
      title: ContactOut
      type: object
    ContactConversationOut:
      properties:
        chatbot_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          title: Chatbot Id
        chatbot_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Chatbot Name
        id:
          format: uuid
          title: Id
          type: string
        last_message_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          title: Last Message At
      required:
      - id
      - chatbot_id
      - chatbot_name
      - last_message_at
      title: ContactConversationOut
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    ContactDetailOut:
      properties:
        ai_paused:
          title: Ai Paused
          type: boolean
        conversation_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          title: Conversation Id
        conversations:
          items:
            $ref: '#/components/schemas/ContactConversationOut'
          title: Conversations
          type: array
        created_at:
          format: date-time
          title: Created At
          type: string
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        id:
          format: uuid
          title: Id
          type: string
        last_interaction_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          title: Last Interaction At
        name:
          title: Name
          type: string
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        opted_out:
          title: Opted Out
          type: boolean
        phone_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone Number
        tags:
          items:
            type: string
          title: Tags
          type: array
      required:
      - id
      - name
      - phone_number
      - email
      - tags
      - notes
      - created_at
      - last_interaction_at
      - conversation_id
      - ai_paused
      - opted_out
      - conversations
      title: ContactDetailOut
      type: object
  securitySchemes:
    bearerAuth:
      description: 'Personal access token (izap_pat_…) sent as Authorization: Bearer <token>; dashboard session JWTs are also accepted.'
      scheme: bearer
      type: http