Get a user's Do Not Disturb status | Sample

2 parameters

tokenstringoptional

Authentication token with the `dnd:read` scope.

userstringoptional

The user whose Do Not Disturb status to retrieve; defaults to the authenticated user when omitted.

2 status codes

200Returns the user's Do Not Disturb state, snooze state when available, remaining snooze time, and scheduled start and end timestamps.

dnd_enabledbooleanrequired

next_dnd_end_tsintegerrequired

next_dnd_start_tsintegerrequired

okbooleanrequired

Allowed:true

snooze_enabledbooleanoptional

snooze_endtimeintegeroptional

snooze_remainingintegeroptional

defaultReturned when the specified user cannot be found or authentication, permissions, account status, or request encoding is invalid.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:user_not_foundnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

token must provide authentication with the dnd:read scope. When supplied, user must identify an existing user that the authenticated user is permitted to inspect.

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.dndInfo.list({
  token: "sk_live_4eC39Hq",
  user: "octocat",
});

{
  "ok": true
}

Request

Response

Errors