Unarchive a conversation | Sample

1 parameter · 1 body field

tokenstringoptional

Authentication token with the `conversations:write` scope.

Conversation identification data for the archived conversation to restore.

channelstringoptional

ID of conversation to unarchive

2 status codes

200Returns `ok: true` after the conversation has been restored.

okbooleanrequired

Allowed:true

defaultReturned when authentication, conversation access, archive state, 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_archivednot_authedinvalid_authaccount_inactiveuser_is_botuser_is_restricteduser_is_ultra_restrictedinvalid_arg_nameinvalid_array_arg

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

token must provide authentication with the conversations:write scope. Supply channel with the identifier of an archived conversation that can be restored.

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

{
  "ok": true
}

Request

Response

Errors