v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Users

access tokens batch

Generates short-lived access tokens for up to 1,000 active non-admin users in a single request. Requires ORG_ADMIN or campaign API-key access. The server always sets context to 'public_api_bulk'; callers may not supply their own context. Duplicate UUIDs in the input are deduplicated (first occurrence wins). Results are returned in the same order as the deduplicated input array, with per-user error codes for any user that could not be issued a token.

For custom components:

RaiselyComponents.api.all('users').all('access-tokens').all('batch').post(data = {}, params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

post/users/access-tokens/batch

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Request body

Example request

{
  "data": {
    "userUuids": [
      "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    ],
    "redirectTo": "/account/donations"
  }
}

Response

Batch token generation result. Each entry in results corresponds to one deduplicated UUID in the same order. A request can partially succeed — check each entry's error field.

Example response

{
  "data": {
    "results": [
      {
        "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
        "accessToken": "550e8400-e29b-41d4-a716-446655440000",
        "expiresAt": "2026-02-11T12:00:00.000Z",
        "error": {
          "code": "user_not_found"
        }
      }
    ],
    "summary": {
      "succeeded": 2,
      "failed": 2,
      "total": 4
    }
  }
}