---
title: "Update Work Chat"
method: PATCH
path: "/work/chats/{chat_id}"
tags: ["Work"]
---

# Update Work Chat

`PATCH /work/chats/{chat_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/chats/{chat_id}`
- Auth: HTTP bearer

Rename a chat and/or archive or restore it for the caller. PERSONAL KEY ONLY.

Archive is per person; rename is for everyone. Send `title`, `archived`, or both. 404 for a chat that is not the
caller's, 409 once it became a channel, 422 for an empty name.

## Path parameters

- `chat_id` string, required: Chat id

## Headers

- `Idempotency-Key` string, nullable: Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again: send your own for anything you may retry.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WorkChatUpdateBody: A rename and/or an archive change. A field left out is left alone; at least one is required.
  - `title` string, nullable: The chat's new name.
  - `archived` boolean, nullable: True puts the chat in the caller's Archive; false brings it back.

## Response `200`

Successful Response

- ApiResponseWorkChannelPayload
  - `data` WorkChannelPayload, required: A Work channel, chat, output, task, decision or activity document, as the app returns it.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)