Update a conversation topic | Sample

1 parameter · 2 body fields

tokenstringoptional

Authentication token with the `conversations:write` scope.

Conversation topic update data containing the conversation identifier and replacement topic.

channelstringoptional

Conversation to set the topic of

topicstringoptional

The new topic string. Does not support formatting or linkification.

2 status codes

200Returns `ok: true` and the updated conversation object.

channelarrayrequired

okbooleanrequired

Allowed:true

defaultReturned when authentication, permissions, conversation access, or an argument is invalid.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:method_not_supported_for_channel_typemissing_scopechannel_not_foundnot_in_channelis_archivedtoo_longuser_is_restrictednot_authedinvalid_authaccount_inactiveinvalid_arg_nameinvalid_array_arg

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

token must provide authentication with the conversations:write scope. Supply channel and topic to identify the conversation and set its new topic, and ensure topic contains plain text without formatting or linkification.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.conversationsSetTopic.create({
  channel: "example",
  topic: "example",
});

{
  "ok": true
}

Request

Response

Errors