Close a direct message conversation | Sample

1 parameter · 1 body field

tokenstringoptional

Authentication token with the `conversations:write` scope.

Optional request identifying the direct message conversation to close.

channelstringoptional

Conversation to close.

2 status codes

200Confirms the close operation and may include `already_closed` or `no_op` indicators.

already_closedbooleanoptional

no_opbooleanoptional

okbooleanrequired

Allowed:true

defaultReturned when the conversation type does not support closing, the conversation cannot be found or closed by the authenticated user, or the request is malformed.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:method_not_supported_for_channel_typechannel_not_founduser_does_not_own_channelmissing_scopenot_authedinvalid_authaccount_inactiveinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

channel must identify a direct message or multiperson direct message conversation that the authenticated user can close. The authentication token must have the conversations:write scope.

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.conversationsClose.create({ channel: "example" });

{
  "ok": true
}

Request

Response

Errors