Set a user's active status | Sample

1 parameter

tokenstringrequired

Authentication token with the `users:write` scope.

2 status codes

200Returns an object containing `ok` set to true according to the legacy success schema.

okbooleanrequired

Allowed:true

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredekm_access_deniedmissing_scopeinvalid_argumentsinvalid_arg_nameinvalid_charsetinvalid_form_data

okbooleanrequired

Allowed:false

Error handling

token must carry the users:write scope. The operation is deprecated and non-functional, so do not rely on it to change a user's status.

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

{
  "ok": true
}

Request

Response

Errors