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

# Unipile: Update Chat

> Changes a chat in the customer’s connected account: mark it read or unread, mute or unmute it, archive it, or retrieve a group invite link, as set by `action`.

Changes a chat in the customer’s connected account: mark it read or unread, mute or unmute it, archive it, or retrieve a group invite link, as set by `action`.

> [!NOTE]
>
> Tool ID: `unipile_update_chat`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_update_chat',
  {
    "chat_id": "chat_123",
    "action": "setReadStatus"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_update_chat --input '{
  "chat_id": "chat_123",
  "action": "setReadStatus"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "ChatPatched"
  }
}
```

Use `deepline describe unipile_update_chat --json` for the latest machine-readable contract.

## Input reference

Perform an action like changing the read status, muting the chat, retrieving a group invite link, etc.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.chat_id` | `string` | Yes | — | The id of the chat to be patched |
| `payload.action` | `"setReadStatus" \| "setMuteStatus" \| "setArchiveStatus" \| "setPinnedStatus" \| "addParticipant" \| "removeParticipant" \| "setLabel" \| "getInviteLink"` | Yes | — | The action to perform on the chat: - `setReadStatus`: (WhatsApp & LinkedIn only) Set the read status of the chat. - `setMuteStatus`: (WhatsApp & LinkedIn only) Set the mute status of the chat. - `setArchiveStatus`: (WhatsApp only) Set the archive status of the chat. - `setPinnedStatus`: (WhatsApp only) Set the pinned status of the chat. - `addParticipant`: (WhatsApp & Telegram only) Add a participant to the group chat. The account owner must have the Add other members permission in the group. See the live schema for the complete constraint. |
| `payload.value` | `boolean \| string` | No | — | Required for every action except `getInviteLink`. Use a boolean for status actions and a string for participant or label actions. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Perform an action like changing the read status, muting the chat, retrieving a group invite link, etc.",
    "properties": {
      "chat_id": {
        "type": "string",
        "description": "The id of the chat to be patched"
      },
      "action": {
        "type": "string",
        "description": "The action to perform on the chat: - `setReadStatus`: (WhatsApp & LinkedIn only) Set the read status of the chat. - `setMuteStatus`: (WhatsApp & LinkedIn only) Set the mute status of the chat. - `setArchiveStatus`: (WhatsApp only) Set the archive status of the chat. - `setPinnedStatus`: (WhatsApp only) Set the pinned status of the chat. - `addParticipant`: (WhatsApp & Telegram only) Add a participant to the group chat. The account owner must have the Add other members permission in the group. Provide the provider ID as value, for example 334455667788@s.whatsapp.net for WhatsApp, or a Telegram user ID, username, or phone number for Telegram. - `removeParticipant`: (WhatsApp & Telegram only) Remove a participant from the group chat. Provide the provider ID as value, for example 334455667788@s.whatsapp.net for WhatsApp, or a Telegram user ID, username, or phone number for Telegram. - `setLabel`: (WhatsApp only) Add a label to the chat. If the label does not exist, it will be created and then assigned. - `getInviteLink`: (WhatsApp & Telegram only) Generate or retrieve the full group invite link. The account owner must have the required invite permissions in the group.",
        "enum": [
          "setReadStatus",
          "setMuteStatus",
          "setArchiveStatus",
          "setPinnedStatus",
          "addParticipant",
          "removeParticipant",
          "setLabel",
          "getInviteLink"
        ]
      },
      "value": {
        "description": "Required for every action except `getInviteLink`. Use a boolean for status actions and a string for participant or label actions.",
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "string"
          }
        ]
      }
    },
    "required": [
      "chat_id",
      "action"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"ChatPatched"` | Yes | — | Allowed: `ChatPatched`. |
| `result.data.invite_link` | `string` | No | — | The full group invite link. Only returned for the `getInviteLink` action. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "ChatPatched"
            ]
          },
          "invite_link": {
            "type": "string",
            "description": "The full group invite link. Only returned for the `getInviteLink` action."
          }
        },
        "required": [
          "object"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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