Request additional app permissions | Sample

3 parameters

tokenstringrequired

Authentication token with no additional required scope.

scopesstringrequired

Comma-separated list of scopes to request for the app.

trigger_idstringrequired

Token used to trigger the permissions API.

2 status codes

200Returns an object with `ok` set to true when the additional permission request is accepted.

okbooleanrequired

Allowed:true

defaultReturns an object with `ok` set to false and an `error` value describing why the permission request failed.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:invalid_triggertrigger_exchangedinvalid_scopeinvalid_usernot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_name

okbooleanrequired

Allowed:false

Error handling

token, scopes, and trigger_id are all required. Provide scopes as a comma-separated string of permissions and use a valid, unexpired trigger_id for the request.

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.appsPermissionsRequest.list({
  token: "sk_live_4eC39Hq",
  scopes: "example",
  triggerId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "ok": true
}

Request

Response

Errors