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

# Create a contact

> Creates a contact. `name` is required; `email`, `phone_number`, `identifier` and `custom_attributes` are optional. The body is wrapped in `contact`.

Before anything is written, the account is checked for a contact with the same email address (ignoring case), the same phone number (a Brazilian number with or without the ninth digit is the same number) or the same identifier. If one exists, nothing is created and the response is a `409` whose `error.details[0].existing_contact_id` is the id of the contact that already exists: [update that contact](/api-reference/cloudchat/endpoints/update-a-contact) instead of retrying.

`email` must be a valid address and is stored in lower case. `phone_number` is stored in E.164 (for example `+5511987654321`): send it with `+` and the country code. Digits without `+` that look like a Brazilian area code plus number are read as Brazilian and stored with `+55`.

A contact created with no email, phone number or identifier is stored, but [search contacts](/api-reference/cloudchat/endpoints/search-contacts) does not return it, so keep the id from the response. The new contact is not attached to any inbox or conversation.

Only account administrators can create contacts through this API.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts
openapi: 3.0.1
info:
  title: Cloud Chat API
  version: v1
  description: >-
    The curated public surface of Cloud Chat. Every call needs two things: the
    Bearer token from `POST /auth/v1/signin`, and the `cloudchat-instance`
    header that says which Cloud Chat instance your company lives on.


    If you don't know your instance value, the [Find your
    credentials](/api-reference/cloudchat/credentials) page reads it out of your
    own token in the browser.
servers:
  - url: https://api.cloudhumans.com/cloudchat
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Canned Responses
    description: >-
      Canned responses — the shortcuts agents expand while replying. Each one
      belongs to a single account and is identified by its short code.
  - name: Conversations
    description: >-
      The conversations of an account: read them, change their priority and
      status, assign them, leave internal notes, and block or unblock the
      contact of a conversation. Answering the customer, opening a conversation
      and deleting one are not part of this surface. What you can see and change
      follows the same rule as the dashboard: an administrator token reaches
      every inbox, an agent token only the inboxes it is a member of.
  - name: Contacts
    description: >-
      Customer contacts of the account, with their personal data. Administrators
      only.
  - name: Help Center
    description: >-
      Portals, categories and articles of the help center — the public FAQ your
      customers read.
  - name: Uploads
    description: Store the images help center articles embed.
  - name: Labels
    description: >-
      The label definitions of an account: the tags conversations and contacts
      carry. Listing and reading are open to any member; creating and updating a
      label need an administrator or CX engineer token. Renaming a label retags
      the records that carry it. There is no delete: removing a label and
      creating another with the same title would bring the old tags back. The
      same group applies labels to a conversation or a contact and takes them
      off again.
  - name: Inboxes
    description: >-
      The inboxes a token can see — every inbox of the account for an
      administrator, only its memberships for an agent. Administrators can also
      change an inbox's name, greeting, working hours and CSAT toggle. Never
      includes the channel's credentials, and the channel itself is not editable
      here.
  - name: Agents
    description: >-
      Read-only access to the human and AI agents of an account. A hidden admin
      (the platform's own support user) never appears, on the list or by id.
  - name: Teams
    description: >-
      Teams group agents for assignment. Listing and reading are open to any
      member; creating and updating a team, and managing its membership, require
      an administrator token. A system-managed team (provisioned by the
      platform) can be read like any other but never updated.
  - name: Macros
    description: >-
      Macros bundle a sequence of actions an agent runs against a conversation
      from the dashboard. This surface lets you list, read and write macro
      definitions — running one is not part of the v1 contract. A macro is
      either `global` (visible to the whole account) or `personal` (visible only
      to its author); an agent token can only create personal macros.
  - name: Automation Rules
    description: >-
      The account's automation rules — administrator only. An agent token gets a
      403 on every operation in this group.


      Reading is direct. Writing goes through a propose → confirm pair: the
      propose call validates the change, writes nothing, and returns a
      single-use `proposal_token` with a preview and a list of `warnings`; the
      confirm call sends the token back and applies exactly what was previewed.
      Rules created through the API start off, and turning a rule on or off
      stays with a person in the Cloud Chat automations screen.
  - name: Availability Reasons
    description: >-
      The reasons an agent can go `busy` for, configured per account. Listing is
      open to any member; creating, updating and deleting require an
      administrator token. Deleting is a soft delete — the reason disappears
      from listings but agents' past availability history keeps referencing it.
  - name: Native Attribute Requirements
    description: >-
      Which native conversation attributes (priority, assignee, tag, team) the
      account requires agents to fill before resolving a conversation. Listing
      is open to any member; requiring and un-requiring need an administrator
      token. Deleting a requirement is reversible — require the same key again
      to restore it.
  - name: Custom Attributes
    description: >-
      The custom fields an account added to conversations, contacts and
      companies, and their definitions: key, type, model and options. Listing
      and reading are open to any member; creating and editing need an
      administrator token. Deleting a definition, conditional sub-lists and the
      AI fill settings stay in the Cloud Chat screen.
  - name: Campaigns
    description: Check who a campaign would reach, send it, and read the result back.
  - name: Reports
    description: The numbers of the Cloud Chat reporting dashboards, read through the API.
  - name: Companies
    description: >-
      Companies (the businesses your contacts work for) and the links between
      contacts and companies. Companies must be enabled for the account; when
      they are not, every operation in this group answers `403`. Any member of
      the account can read. Updating a company and linking or unlinking contacts
      is open to agents, supervisors, CX engineers and administrators; an
      assistant is read-only.
paths:
  /v1/accounts/{accountId}/contacts:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
    post:
      tags:
        - Contacts
      summary: Create a contact
      description: >-
        Creates a contact. `name` is required; `email`, `phone_number`,
        `identifier` and `custom_attributes` are optional. The body is wrapped
        in `contact`.


        Before anything is written, the account is checked for a contact with
        the same email address (ignoring case), the same phone number (a
        Brazilian number with or without the ninth digit is the same number) or
        the same identifier. If one exists, nothing is created and the response
        is a `409` whose `error.details[0].existing_contact_id` is the id of the
        contact that already exists: [update that
        contact](/api-reference/cloudchat/endpoints/update-a-contact) instead of
        retrying.


        `email` must be a valid address and is stored in lower case.
        `phone_number` is stored in E.164 (for example `+5511987654321`): send
        it with `+` and the country code. Digits without `+` that look like a
        Brazilian area code plus number are read as Brazilian and stored with
        `+55`.


        A contact created with no email, phone number or identifier is stored,
        but [search
        contacts](/api-reference/cloudchat/endpoints/search-contacts) does not
        return it, so keep the id from the response. The new contact is not
        attached to any inbox or conversation.


        Only account administrators can create contacts through this API.
      operationId: createContact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactCreateRequest'
      responses:
        '201':
          description: Created. The body is the contact itself, not wrapped in `data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '400':
          description: >-
            The request is malformed: a body that is not valid JSON, no
            `contact` in it, or a `contact` that is not an object. Nothing was
            created. Also answered when `accountId` is not a number, and when
            the `cloudchat-instance` header is missing or holds a value we do
            not route, which answers with a plain `{ "error": "..." }` string
            instead of the usual object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: bad_request
                  message: The request is malformed.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ContactsForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ContactConflict'
        '422':
          $ref: '#/components/responses/ContactValidationFailed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    CloudChatInstance:
      name: cloudchat-instance
      in: header
      required: true
      description: >-
        Your Cloud Chat instance ID — an integer, fixed for your company, told
        at onboarding. [The API
        overview](/api-reference/cloudchat/overview#two-headers-every-call)
        explains how instances work, how to find yours, and the errors a wrong
        or missing value produces.
      schema:
        type: integer
        example: 1
    AccountId:
      name: accountId
      in: path
      required: true
      description: >-
        Your Cloud Chat account. It has to be an account your token grants
        membership on, and it has to live on the instance in the
        `cloudchat-instance` header — the two travel together. Account numbers
        are only unique **within** an instance, so the same number is a
        different company on another instance. Usually a mismatched pair fails
        closed with a 401, because your user does not exist on the other
        instance — but if your identity happens to exist on both, the call
        succeeds against the other company's data, silently. Read it and you are
        looking at the wrong help center; write it and you have stored into the
        wrong account. Send the two values that were given to you together, and
        never try a number to see what answers.
      schema:
        type: integer
        example: 1
  schemas:
    ContactCreateRequest:
      type: object
      required:
        - contact
      properties:
        contact:
          type: object
          required:
            - name
          properties:
            name:
              type: string
              example: Maria Silva
              description: Required and not blank.
            email:
              type: string
              example: maria.silva@example.com
              description: >-
                A valid email address, stored in lower case. No other contact of
                the account can have the same one.
            phone_number:
              type: string
              example: '+5511987654321'
              description: >-
                In E.164, with `+` and the country code, for example
                `+5511987654321`. Digits without `+` that look like a Brazilian
                area code plus number are read as Brazilian and stored with
                `+55`. No other contact of the account can have the same number.
            identifier:
              type: string
              example: crm-4821
              description: >-
                The id your own systems use for this contact. No other contact
                of the account can have the same one.
            custom_attributes:
              type: object
              additionalProperties: true
              description: >-
                Custom attributes, keyed by attribute key. A key with a `null`
                value is ignored.
              example:
                plan: pro
    Contact:
      type: object
      description: A customer contact of the account.
      required:
        - id
        - name
        - email
        - phone_number
        - identifier
        - custom_attributes
        - created_at
        - last_activity_at
      properties:
        id:
          type: integer
          description: >-
            The contact id — the same `contact.id` the conversation endpoints
            return.
          example: 815
        name:
          type: string
          nullable: true
          description: >-
            The display name. Often what the channel reported, such as a
            WhatsApp profile name; an empty string when unknown.
          example: Jane Doe
        email:
          type: string
          nullable: true
          description: The email address, `null` when the contact has none.
          example: jane@example.com
        phone_number:
          type: string
          nullable: true
          description: The phone number in E.164, `null` when the contact has none.
          example: '+5511999998888'
        identifier:
          type: string
          nullable: true
          description: >-
            The id your own systems use for this contact, when one was set
            through an integration; `null` otherwise.
          example: crm-42
        custom_attributes:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            The contact's custom attributes, keyed by attribute key, exactly as
            configured on the account. An empty object when none are set.
          example:
            plan: pro
        created_at:
          type: string
          format: date-time
          description: When the contact was created. ISO 8601 in UTC, with milliseconds.
          example: '2026-09-02T14:03:11.215Z'
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the contact last had activity, in the same format. `null` when
            it never had any.
          example: '2026-10-20T09:41:27.000Z'
    Error:
      type: object
      description: The error envelope every Cloud Chat API response uses.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                The stable, machine-readable reason. Branch on this, never on
                `message`.
              enum:
                - unauthorized
                - forbidden
                - not_found
                - validation_failed
                - conflict
                - bad_request
                - internal_error
                - rate_limited
                - service_unavailable
              example: not_found
            message:
              type: string
              description: >-
                The reason in words, localized to your account's language
                (English, Spanish or Brazilian Portuguese; English when the
                account is set to anything else). Wording changes with the
                account and between releases, so never match on it.


                Two cases stay in English whatever the account is set to:
                `unauthorized`, decided before any account is known, and the
                account-level `not_found`, which must not reveal the account's
                language.
              example: Resource could not be found.
            details:
              type: array
              description: >-
                Present on some rejections — a 400 for a refused query parameter
                or upload mode, for example. One entry per offending field,
                localized to the account's language like `message` — match on
                `code` and `field`, never on the text.
              items:
                type: object
                required:
                  - field
                  - code
                  - message
                properties:
                  field:
                    type: string
                    description: Which request field the rule was about.
                  code:
                    type: string
                    description: Stable, machine-readable reason.
                  message:
                    type: string
                    description: The rule in words.
    ContactConflictError:
      type: object
      description: A `conflict` error, which carries the contact that already exists.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - conflict
              example: conflict
            message:
              type: string
              description: >-
                Localized to the account's language, like every other envelope
                message.
            details:
              type: array
              description: The value that repeats, with the contact that already has it.
              items:
                type: object
                required:
                  - field
                  - code
                  - message
                  - existing_contact_id
                properties:
                  field:
                    type: string
                    enum:
                      - identifier
                      - email
                      - phone_number
                    description: >-
                      Which value repeats. Checked in this order: `identifier`,
                      `email`, `phone_number`; when several repeat, only the
                      first is reported.
                    example: email
                  code:
                    type: string
                    enum:
                      - duplicate
                    example: duplicate
                  message:
                    type: string
                    description: The rule in words, with the id of the existing contact.
                  existing_contact_id:
                    type: integer
                    example: 815
                    description: >-
                      The id of the contact that already has this value. Pass it
                      to [update a
                      contact](/api-reference/cloudchat/endpoints/update-a-contact).
    ContactValidationError:
      type: object
      description: A `validation_failed` error on a contact, which carries `details`.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - validation_failed
              example: validation_failed
            message:
              type: string
              description: >-
                Localized to the account's language, like every other envelope
                message.
            details:
              type: array
              description: One entry per rejected field.
              items:
                type: object
                required:
                  - field
                  - code
                  - message
                properties:
                  field:
                    type: string
                    enum:
                      - name
                      - email
                      - phone_number
                      - identifier
                      - custom_attributes
                      - base
                    description: >-
                      Which request field the rule was about. A rule that is not
                      tied to one is reported as `base`.
                    example: email
                  code:
                    type: string
                    description: >-
                      Which rule it broke: `blank` for a missing, blank or
                      cleared value, `invalid` for a value that is not an email
                      address or an E.164 number or has the wrong shape, `taken`
                      for a value another contact already has. Other codes can
                      appear; match on `field`.
                    example: taken
                  message:
                    type: string
                    description: The rule in words.
    GatewayError:
      type: object
      description: >-
        Rejected by the gateway before Cloud Chat saw it, so it does not use the
        `error` envelope.
      required:
        - message
      properties:
        message:
          type: string
          example: API rate limit exceeded
        request_id:
          type: string
          description: Gateway request id. Quote it when reporting a problem.
          example: f3f7567638d4b65a8003057d0c77d275
  responses:
    Unauthorized:
      description: >-
        No Bearer token, or one that is expired, malformed, or not a Cognito
        token. Sign in again for a fresh `id_token`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: >-
                Authentication is required. Send a valid Bearer token in the
                Authorization header.
    ContactsForbidden:
      description: >-
        Reading and writing contacts needs an administrator of the account; any
        other role answers `403` with the message below. A suspended account
        also answers `403`, and then nothing on it works until it is
        reactivated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: >-
                Contact data is available to account administrators only. Ask an
                administrator of this account to run this request.
    NotFound:
      description: >-
        The resource is not there for you. Three situations answer with this
        code, and the first two apply to **every** endpoint — the account is
        resolved before anything else runs, so a list or a create fails this way
        too:


        - the account does not exist on this instance,

        - the account exists but your token has no membership on it,

        - on an endpoint that names one, the resource it names (a canned
        response, a portal, an article) does not exist where the path says it
        does.


        The first two are deliberately indistinguishable — same status, same
        body, and the message stays in English in both, since translating it
        would reveal the account's configured language. So you cannot use this
        endpoint to find out which account ids exist. The third case is
        localized like every other error, which is safe because you only reach
        it once membership is established.


        Either way a 404 is not worth retrying. Check the `accountId`, the
        `cloudchat-instance` value, and that your user is a member of the
        account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Resource could not be found.
    ContactConflict:
      description: >-
        Another contact of the account already has the same identifier, email or
        phone number. Nothing was created or changed.
        `error.details[0].existing_contact_id` is the contact that already has
        the value: when creating, update it instead of retrying; when updating,
        check whether the two contacts are the same person.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ContactConflictError'
          example:
            error:
              code: conflict
              message: Conflict
              details:
                - field: email
                  code: duplicate
                  message: >-
                    Another contact in this account already has this email; its
                    id is 815. Nothing was created: call updateContact with that
                    id to change it.
                  existing_contact_id: 815
    ContactValidationFailed:
      description: >-
        The payload was understood but the values are not acceptable, and
        nothing was stored. `details` names the offending fields: a blank
        `name`, an `email` that is not an address, a `phone_number` that is not
        a valid E.164 number once normalized, an `email`, `phone_number` or
        `identifier` cleared on update, a `custom_attributes` that is not an
        object, or a field sent as an array or object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ContactValidationError'
          example:
            error:
              code: validation_failed
              message: The request payload is invalid.
              details:
                - field: email
                  code: invalid
                  message: is invalid
    TooManyRequests:
      description: >-
        Rate limited per credential. Note the envelope: this one is `{
        "message": ... }`, because the request never reached the API.


        Don't hardcode the limit — read it from the response. `Retry-After` says
        how many seconds to wait, and every response (not just this one) carries
        `ratelimit-limit`, `ratelimit-remaining` and `ratelimit-reset`, the last
        in seconds.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            message: API rate limit exceeded
    InternalError:
      description: >-
        Something failed on our side. The response never carries the underlying
        error, but it is reported to our monitoring automatically — no need to
        file anything for a one-off.


        Retrying is reasonable, with one caveat on `POST`: a 500 does not prove
        the write did not happen, so a retry can come back `422` with
        `short_code` already taken. That 422 means the first attempt succeeded —
        list the account and confirm before treating it as a failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: internal_error
              message: An unexpected error occurred. Please try again later.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The `id_token` from `POST /auth/v1/signin`, sent as `Authorization:
        Bearer <id_token>`. Not the `access_token` — that one does not carry the
        identity Cloud Chat authorizes on.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.