---
updatedAt: 2026-06-25T13:41:40.000Z
agentTools:
  projectIndex: https://marketing.developer.dotdigital.com/llms.txt
---

# Updates a chat

<span class="callRateUnlimited"></span>

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Chat API",
    "description": "Provides methods for creating, retrieving, updating, and deleting chat\nsessions. Supports operations to assign or close a chat, change its channel,\nsend forms to a chat, manage typing indicators, and retrieve the list of\nchat participants.",
    "version": "1.0.1"
  },
  "servers": [
    {
      "url": "https://{region}-api.dotdigital.com",
      "variables": {
        "region": {
          "description": "The Dotdigital region id your account belongs to",
          "enum": [
            "r1",
            "r2",
            "r3"
          ],
          "default": "r1"
        }
      }
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/cpaas/chats/{chatId}": {
      "put": {
        "summary": "Updates a chat",
        "parameters": [
          {
            "name": "chatId",
            "in": "path",
            "description": "The id of the chat",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "if-match",
            "in": "header",
            "description": "An optional ETag for optimistic concurrency control",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Detail of the chat to update",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChatUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The updated chat",
            "headers": {
              "ETag": {
                "description": "A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE",
                "schema": {
                  "type": "string"
                }
              },
              "Last-Modified": {
                "description": "The date the chat was last updated in ISO 8601 format",
                "schema": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Chat"
                }
              }
            }
          },
          "400": {
            "description": "Validation issues were found",
            "content": {}
          },
          "404": {
            "description": "The chat was not found",
            "content": {}
          },
          "409": {
            "description": "A conncurrency issue occured updating the chat",
            "content": {}
          },
          "412": {
            "description": "The specified 'if-match' header was not valid, refresh and retry",
            "content": {}
          }
        },
        "x-codegen-request-body-name": "name"
      }
    }
  },
  "components": {
    "schemas": {
      "ChatUpdate": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the chat"
          },
          "description": {
            "type": "string",
            "description": "The description of the chat"
          }
        }
      },
      "Chat": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the chat"
          },
          "name": {
            "type": "string",
            "description": "The name of the chat"
          },
          "description": {
            "type": "string",
            "description": "The description of the chat"
          },
          "teamId": {
            "type": "string",
            "description": "The id of the team owning this chat"
          },
          "originalTeamId": {
            "type": "string",
            "description": "The id of the team the chat was created against",
            "readOnly": true
          },
          "channelId": {
            "type": "string",
            "description": "The id of the channel initiating this chat"
          },
          "status": {
            "type": "string",
            "description": "The current status of this chat",
            "enum": [
              "new",
              "replied",
              "closed"
            ]
          },
          "participants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Participant"
            }
          },
          "context": {
            "$ref": "#/components/schemas/ChatContext"
          },
          "_createdOn": {
            "type": "string",
            "description": "The date (in UTC, ISO 8601 format) that the chat was created",
            "format": "date-time",
            "readOnly": true
          },
          "_createdBy": {
            "type": "string",
            "description": "The identity that created the chat"
          },
          "_updatedOn": {
            "type": "string",
            "description": "The date (in UTC, ISO 8601 format) that the chat was last updated",
            "format": "date-time",
            "readOnly": true
          },
          "_updatedBy": {
            "type": "string",
            "description": "The identity that created the chat",
            "readOnly": true
          }
        }
      },
      "Participant": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id of the chat participant's profile"
          },
          "role": {
            "type": "string",
            "description": "The role of the chat participant",
            "enum": [
              "agent",
              "participant"
            ],
            "default": "participant"
          }
        }
      },
      "ChatContext": {
        "type": "object",
        "properties": {
          "conversationId": {
            "type": "string",
            "description": "Optional conversationId, used to correlated messages on the channel used for the chat"
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "csharp",
      "java",
      "node",
      "php",
      "python",
      "ruby"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```

# Sibling pages

* [Retrieves a chat](https://marketing.developer.dotdigital.com/reference/get_cpaas-chats-chatid.md)
* [Deletes a chat](https://marketing.developer.dotdigital.com/reference/delete_cpaas-chats-chatid.md)