Leave a conversation | Sample

1 parameter · 1 body field

tokenstringoptional

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

Optional form-encoded conversation details.

channelstringoptional

Conversation to leave

2 status codes

200Returns a success object with `ok` set to true and may include `not_in_channel` set to true when the authenticated user was not a member.

not_in_channelbooleanoptional

Allowed:true

okbooleanrequired

Allowed:true

defaultTypical error response when attempting to leave a workspace's "general" channel

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:method_not_supported_for_channel_typelast_membermissing_scopechannel_not_foundis_archivedcant_leave_generalnot_authedinvalid_authaccount_inactiveuser_is_botuser_is_restricteduser_is_ultra_restricted

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

channel must identify a conversation that the authenticated user can leave and must not be the workspace's general channel. 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.conversationsLeave.create({ channel: "example" });

{
  "ok": true
}

Request

Response

Errors