Rename a conversation | Sample

1 parameter · 2 body fields

tokenstringoptional

Authentication token for the request; it must provide the `conversations:write` scope.

Optional form-encoded conversation rename details.

channelstringoptional

ID of conversation to rename

namestringoptional

New name for conversation.

2 status codes

200Returns a success object with `ok` set to true and the renamed conversation in `channel`.

channelarrayrequired

okbooleanrequired

Allowed:true

defaultTypical error response when the calling user is not a member of the conversation

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:user_is_restrictedmethod_not_supported_for_channel_typemissing_scopechannel_not_foundnot_in_channelnot_authorizedinvalid_namename_takeninvalid_name_requiredinvalid_name_punctuationinvalid_name_maxlengthinvalid_name_specials

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

channel must identify a conversation the authenticated user can rename, and name must be a valid new conversation name. The token must provide the conversations:write scope when supplied for authentication.

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.conversationsRename.create({
  channel: "example",
  name: "Untitled",
});

{
  "channel": {
    "created": 1449252889,
    "creator": "W012A3BCD",
    "id": "C012AB3CD",
    "is_archived": false,
    "is_channel": true,
    "is_ext_shared": false,
    "is_general": true,
    "is_group": false,
    "is_im": false,
    "is_member": true,
    "is_mpim": false,
    "is_org_shared": false,
    "is_pending_ext_shared": false,
    "is_private": false,
    "is_read_only": false,
    "is_shared": false,
    "last_read": "1502126650.228446",
    "locale": "en-US",
    "name": "general",
    "name_normalized": "general",
    "num_members": 23,
    "pending_shared": [],
    "previous_names": [
      "specifics",
      "abstractions",
      "etc"
    ],
    "purpose": {
      "creator": "W012A3BCD",
      "last_set": 1449709364,
      "value": "This part of the workspace is for fun. Make fun here."
    },
    "topic": {
      "creator": "W012A3BCD",
      "last_set": 1449709364,
      "value": "For public discussion of generalities"
    },
    "unlinked": 0
  },
  "ok": true
}

Request

Response

Errors