Chat Thread - Update Chat Thread Properties

Reference

Service:: Communication

API Version:: 2024-03-07

Updates a thread's properties.

PATCH {endpoint}/chat/threads/{chatThreadId}?api-version=2024-03-07

URI Parameters

Name	In	Required	Type	Description
chatThreadId	path	True	string	The id of the thread to update.
endpoint	path	True	string	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Media Types: "application/merge-patch+json"

Name	Required	Type	Description
Authorization	True	string	An ACS (Azure Communication Services) user access token.

Request Body

Media Types: "application/merge-patch+json"

Name	Type	Description
topic	string	Chat thread topic.

Responses

Name	Type	Description
204 No Content		Thread was successfully updated.
401 Unauthorized	CommunicationErrorResponse	Unauthorized.
403 Forbidden	CommunicationErrorResponse	Forbidden.
429 Too Many Requests	CommunicationErrorResponse	Too many requests.
Other Status Codes	CommunicationErrorResponse	Service unavailable.

Security

Authorization

An ACS (Azure Communication Services) user access token.

Type: apiKey
In: header

Examples

Update chat thread topic

Sample request

HTTP

PATCH https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2024-03-07

{
  "topic": "Updated Thread Topic"
}

Sample response

Status code:: 204

Status code:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Status code:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Status code:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Status code:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definitions

UpdateChatThreadRequest

Request payload for updating a chat thread.

Name	Type	Description
topic	string	Chat thread topic.

Share via