Set manual user presence | Sample

1 parameter · 1 body field

tokenstringrequired

Authentication token with the `users:write` scope.

Form data containing the manual presence state.

presencestringrequired

Either `auto` or `away`

2 status codes

200Returns an object containing `ok` set to true.

okbooleanrequired

Allowed:true

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:invalid_presencenot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

token must carry the users:write scope. presence must be supplied and must be either auto or away.

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

{
  "ok": true
}

Request

Response

Errors