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

# Block the contact of a conversation

> Block the customer of a conversation on the inbox it lives in — the **Block contact** button of the dashboard.

What happens:

- The conversation is **resolved** right away, with the same events as any resolution. As with the dashboard, resolving can make Cloud Chat send the customer the satisfaction survey when the inbox has it enabled, and that message cannot be taken back.
- The customer is marked as **blocked on that inbox**. The block covers every conversation they have there and none they have on another inbox.
- While it lasts, the customer's messages are still received and kept, but they no longer reopen a conversation. On every inbox type except the website widget, a new conversation the customer starts is created already resolved, so nothing reaches the team's queue. On a website widget inbox a new conversation still opens normally, and the customer stops receiving the email copy of agent replies.
- It is a Cloud Chat setting only: the customer is not told, and nothing is blocked at the channel provider (WhatsApp, Instagram and so on). An activity line in the conversation records who blocked the contact.

Blocking is idempotent: when the customer is already blocked on the inbox, the call answers 200 with the current state and changes nothing. Lift the block with [Unblock the contact of a conversation](/api-reference/cloudchat/endpoints/unblock-the-contact-of-a-conversation).

Which roles may block is chosen per account by its administrators in the account setting **Roles allowed to block contacts**. By default every role except Assistant can; a role without the permission gets a 403 and nothing changes. A customer whose email already bounced on the inbox is already blocked by the system and answers 409, and so does a conversation mirrored from another helpdesk, which is read-only here.

The response reads the state back after the write: `muted`, the conversation `status`, and the `contact` and `inbox` the block applies to. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/mute
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}/conversations/{conversationId}/mute:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ConversationId'
    post:
      tags:
        - Conversations
      summary: Block the contact of a conversation
      description: >-
        Block the customer of a conversation on the inbox it lives in — the
        **Block contact** button of the dashboard.


        What happens:


        - The conversation is **resolved** right away, with the same events as
        any resolution. As with the dashboard, resolving can make Cloud Chat
        send the customer the satisfaction survey when the inbox has it enabled,
        and that message cannot be taken back.

        - The customer is marked as **blocked on that inbox**. The block covers
        every conversation they have there and none they have on another inbox.

        - While it lasts, the customer's messages are still received and kept,
        but they no longer reopen a conversation. On every inbox type except the
        website widget, a new conversation the customer starts is created
        already resolved, so nothing reaches the team's queue. On a website
        widget inbox a new conversation still opens normally, and the customer
        stops receiving the email copy of agent replies.

        - It is a Cloud Chat setting only: the customer is not told, and nothing
        is blocked at the channel provider (WhatsApp, Instagram and so on). An
        activity line in the conversation records who blocked the contact.


        Blocking is idempotent: when the customer is already blocked on the
        inbox, the call answers 200 with the current state and changes nothing.
        Lift the block with [Unblock the contact of a
        conversation](/api-reference/cloudchat/endpoints/unblock-the-contact-of-a-conversation).


        Which roles may block is chosen per account by its administrators in the
        account setting **Roles allowed to block contacts**. By default every
        role except Assistant can; a role without the permission gets a 403 and
        nothing changes. A customer whose email already bounced on the inbox is
        already blocked by the system and answers 409, and so does a
        conversation mirrored from another helpdesk, which is read-only here.


        The response reads the state back after the write: `muted`, the
        conversation `status`, and the `contact` and `inbox` the block applies
        to. Visibility follows the same rule as the list: an administrator token
        reaches every inbox of the account, an agent token only its own inbox
        memberships. A conversation outside that reach answers 404,
        indistinguishable from an id that does not exist.
      operationId: muteConversation
      responses:
        '200':
          description: >-
            The state after the call: `muted: true`, the conversation status and
            the contact and inbox the block applies to. The same answer, with
            nothing written, when the customer was already blocked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationMuteState'
              example:
                conversation_id: 1042
                muted: true
                status: resolved
                contact:
                  id: 815
                  name: Jane
                inbox:
                  id: 3
                  name: WhatsApp
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Two causes, and `error.message` says which. **Your role may not
            block or unblock contacts**: the account decides this in the account
            setting **Roles allowed to block contacts** and an administrator of
            the account can change it, so ask one. Or **the account is
            suspended**: nothing on it can be read or written until that is
            resolved. Retrying fixes neither.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: forbidden
                  message: >-
                    Your role in this account is not allowed to block or unblock
                    contacts. Account administrators choose which roles can, in
                    the account setting "Roles allowed to block contacts": ask
                    one of them to allow your role, or to run this request.
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            The contact cannot be blocked from here. `error.details[0].code`
            says why — `blocked_by_bounce` (the customer's email bounced on this
            inbox, so the system already blocks them; only correcting the
            contact's email in the dashboard changes that) or
            `external_read_only` (the conversation is mirrored from another
            helpdesk and is read-only in Cloud Chat) — and the message says what
            to do.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                error:
                  code: conflict
                  message: >-
                    The request conflicts with the current state of the
                    resource.
                  details:
                    - field: conversation
                      code: blocked_by_bounce
                      message: >-
                        The contact's email already bounced on this inbox, so
                        the contact is already blocked by the system and there
                        is nothing to block.
        '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
    ConversationId:
      name: conversationId
      in: path
      required: true
      description: >-
        The conversation's **display_id** — the number shown in the dashboard
        URL and delivered in webhooks. It is never the internal database id, and
        it is never the conversation's `uuid`: when all you have is a uuid or a
        helpdesk ticket id, resolve it to a display_id with [Find a
        conversation](/api-reference/cloudchat/endpoints/find-a-conversation)
        first.
      schema:
        type: integer
        example: 1042
  schemas:
    ConversationMuteState:
      type: object
      description: >-
        What a block or unblock left behind, read back after the write so it can
        be confirmed.
      required:
        - conversation_id
        - muted
        - status
        - contact
        - inbox
      properties:
        conversation_id:
          type: integer
          description: The conversation the call was made on, by its display id.
          example: 1042
        muted:
          type: boolean
          description: >-
            Whether the customer is blocked on this inbox after the call: `true`
            after blocking, `false` after unblocking. It reflects a block set
            through the API or by the dashboard button.
          example: true
        status:
          type: string
          enum:
            - open
            - resolved
            - pending
            - snoozed
            - proactive
          description: >-
            The conversation status after the call. Blocking resolves the
            conversation; unblocking leaves the status as it was.
          example: resolved
        contact:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ConversationContact'
          description: >-
            The customer who was blocked or unblocked, `null` on the rare
            conversation without one.
        inbox:
          allOf:
            - $ref: '#/components/schemas/ConversationMuteInbox'
          description: >-
            The inbox the block applies to. The same customer is not affected on
            any other inbox.
    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.
    ValidationError:
      type: object
      description: A `validation_failed` error, 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.
              example: The request payload is invalid.
            details:
              type: array
              description: >-
                One entry per rejected field. Unlike the envelope message above,
                the texts come from the model layer and are in English in
                practice (the model layer ships no translations) — 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 — `short_code` or
                      `content`. A rule that is not tied to either is reported
                      as `base`, so treat `base` as "the payload as a whole"
                      rather than a field you can highlight.
                    enum:
                      - short_code
                      - content
                      - base
                    example: short_code
                  code:
                    type: string
                    description: >-
                      Which rule it broke — `blank` for a missing or empty
                      value, `taken` for a `short_code` already used on the
                      account.
                    example: taken
                  message:
                    type: string
                    example: has already been taken
    ConversationContact:
      type: object
      description: The customer on the other side of the conversation.
      required:
        - id
        - name
      properties:
        id:
          type: integer
          description: The contact id, stable within the instance.
          example: 815
        name:
          type: string
          nullable: true
          description: The contact display name, when known.
          example: Jane
    ConversationMuteInbox:
      type: object
      description: The inbox a customer is blocked or unblocked on.
      required:
        - id
        - name
      properties:
        id:
          type: integer
          description: >-
            The inbox id — the same value the `inbox_id` filter of [List
            conversations](/api-reference/cloudchat/endpoints/list-conversations)
            takes.
          example: 3
        name:
          type: string
          description: The inbox name as shown in the dashboard.
          example: WhatsApp
    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:
    BadRequest:
      description: >-
        The request itself is malformed, before any value is validated:


        - a body that isn't valid JSON, or one with no `canned_response`
        wrapper,

        - a `canned_response` that isn't an object (`{"canned_response":
        "text"}`),

        - `page`, `per_page`, `search` or `sort` sent as an array or a nested
        object (`?page[]=1`, `?sort[x]=y`) instead of a plain value,

        - **the `cloudchat-instance` header missing or holding a value we don't
        route,**

        - an `accountId` that is not a number — including the literal
        `{accountId}` that some API clients send when the argument is left
        unset. This one answers with the normal envelope and `error.details`
        naming `accountId`, and it is deliberately **not** a 404: a 404 would
        mean the account cannot be reached, while this means the value was never
        an account id at all, so re-read the argument instead of trying other
        numbers.


        **Two different shapes answer with 400, and the difference will bite you
        on day one.** That last case is rejected before the request reaches the
        API, so `error` is a plain **string** instead of the usual object:


        ```json

        { "error": "<human-readable message>" }

        ```


        Every other 400 uses the normal envelope, where `error` is an object
        with `code` and `message`. Reading `error.code` without checking the
        type first throws on the missing-header case — which is the most likely
        400 of your first integration. Check `typeof error === "string"` first,
        or read `error?.code` defensively.


        A 400 always means fix the request shape; it never means a value was
        rejected. Rejected values are 422.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: bad_request
              message: The request is malformed.
    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.
    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.
    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.