End Do Not Disturb snooze | Sample

1 parameter

tokenstringrequired

Authentication token with the `dnd:write` scope.

2 status codes

200Returns `ok: true`, the current Do Not Disturb state, and the next scheduled start and end timestamps.

dnd_enabledbooleanrequired

next_dnd_end_tsintegerrequired

next_dnd_start_tsintegerrequired

okbooleanrequired

Allowed:true

snooze_enabledbooleanrequired

defaultReturned when snooze is not active or cannot be ended, or when authentication, permissions, account status, or request encoding is invalid.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:snooze_not_activesnooze_end_failednot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charset

okbooleanrequired

Allowed:false

Error handling

token must provide authentication with the dnd:write scope. The authenticated user must have an active snooze mode that can be ended.

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.dndEndSnooze.create();

{
  "ok": true
}

Request

Response

Errors