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

# Update a contact

> Updates the contact with this id. Kai never creates a contact here. If
the id does not exist, the response is 404.

A key that you do not send keeps its stored value. A key set to `null`
clears the value. Attributes merge into the stored attributes, so a
request that carries one attribute leaves the others as they are.




## OpenAPI

````yaml /openapi.yaml patch /contacts/{id}
openapi: 3.1.0
info:
  title: Kai Contacts API
  version: 1.0.0
  description: |
    Push, update, assign and export the contacts of one Kai workspace.

    Every request needs an API key. Make a key in Kai, under
    **Settings → API**. Send the key in the `Authorization` header.

    The API works on one workspace. The key decides which workspace, so no
    request carries a workspace id.
  contact:
    name: Kai support
    url: https://kaisupport.com
servers:
  - url: https://kaisupport.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Contacts
    description: Customer profiles, their attributes and their account owners.
  - name: Attributes
    description: The attributes that the workspace keeps on every contact.
  - name: Members
    description: The teammates of the workspace. Read-only.
paths:
  /contacts/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The Kai contact id.
        schema:
          type: string
          format: uuid
    patch:
      tags:
        - Contacts
      summary: Update a contact
      description: |
        Updates the contact with this id. Kai never creates a contact here. If
        the id does not exist, the response is 404.

        A key that you do not send keeps its stored value. A key set to `null`
        clears the value. Attributes merge into the stored attributes, so a
        request that carries one attribute leaves the others as they are.
      operationId: patchContact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactWrite'
            example:
              attributes:
                package: Tam Paket
              note: null
      responses:
        '200':
          description: The updated contact.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactEnvelope'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/IdentityConflict'
        '422':
          $ref: '#/components/responses/InvalidAttributes'
components:
  schemas:
    ContactWrite:
      type: object
      description: |
        A key that you do not send keeps its stored value. A key set to `null`
        clears the value.
      properties:
        external_id:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        note:
          type:
            - string
            - 'null'
        attributes:
          type: object
          description: |
            Values by API name. Kai refuses an unknown or archived key with a
            422 response, and names the key that it refused.
          additionalProperties:
            type:
              - string
              - number
              - boolean
              - 'null'
        owner:
          type:
            - string
            - 'null'
          description: A member id, the email of a member, or `null` to clear the owner.
        identities:
          type: array
          description: More handles that identify this person.
          items:
            $ref: '#/components/schemas/Identity'
    ContactEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Contact'
    Identity:
      type: object
      required:
        - kind
        - value
      properties:
        kind:
          type: string
          enum:
            - channel
            - email
            - phone
            - external
          description: |
            `channel` is a handle from a messaging channel, in the form
            `whatsapp_cloud:905321112233` or `intercom:5f3a...`.
        value:
          type: string
    Contact:
      type: object
      required:
        - id
        - attributes
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: The Kai contact id.
        external_id:
          type:
            - string
            - 'null'
          description: Your own id for this person. It is unique in the workspace.
        name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        note:
          type:
            - string
            - 'null'
          description: A note for teammates. Kai does not send it to a customer.
        attributes:
          type: object
          description: The workspace attributes of this contact, by API name.
          additionalProperties:
            type:
              - string
              - number
              - boolean
              - 'null'
        owner:
          type:
            - object
            - 'null'
          description: The account owner, or `null`.
          properties:
            member_id:
              type: string
              format: uuid
            name:
              type:
                - string
                - 'null'
            email:
              type:
                - string
                - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    ErrorBody:
      type: object
      properties:
        type:
          type: string
          description: A stable machine name for the error.
        message:
          type: string
          description: One sentence for a human reader.
        details:
          description: The attributes or the identities that caused the error.
  responses:
    BadRequest:
      description: Kai could not read the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              message: >-
                Send at least one of "external_id", "email", "phone" or
                "identities" so the contact can be matched.
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: unauthorized
              message: That API key is not valid.
    Forbidden:
      description: The API key does not have the permission that this endpoint needs.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: forbidden
              message: This key does not have the "contacts:write" permission.
    NotFound:
      description: There is no such record in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: not_found
              message: No such contact.
    IdentityConflict:
      description: |
        The identities in the request belong to two different contacts. Kai
        does not merge contacts.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: identity_conflict
              message: >-
                Those identifiers already belong to two different contacts. Kai
                does not merge contacts automatically.
              details:
                - kind: email
                  value: ayse@example.com
                - kind: phone
                  value: '905321112233'
    InvalidAttributes:
      description: One or more attributes could not be stored. The response names each one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_attributes
              message: Some attributes could not be stored.
              details:
                - key: exam_year
                  message: expected a number
                - key: cohort
                  message: no such workspace attribute
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Send your API key as `Authorization: Bearer kai_live_...`.

        Make and revoke keys in Kai, under **Settings → API**. Kai stores only
        a hash of the key, so the full key is shown one time.

````