Archive a conversation | Sample

1 parameter · 1 body field

tokenstringoptional

Authentication token with the `conversations:write` scope.

Optional conversation archive request containing the conversation identifier.

channelstringoptional

ID of conversation to archive

2 status codes

200Confirms that the conversation was archived successfully.

okbooleanrequired

Allowed:true

defaultReturned when the conversation type does not support archiving, the conversation cannot be found or is already archived, or authentication or permissions are insufficient.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:method_not_supported_for_channel_typemissing_scopenot_supportedchannel_not_foundalready_archivedcant_archive_generalrestricted_actionnot_authedinvalid_authaccount_inactiveuser_is_botuser_is_restricted

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

channel must identify the conversation to archive, and the authentication token must have the conversations:write scope. The conversation must support archiving and must not already be archived.

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

{
  "ok": true
}

Request

Response

Errors