Skip to content
/Users

Admin API Reference (2026-01-08)

The Zephr Admin API provides RESTful access to all Zephr functionality. It is designed for server-side integrations. All requests must be signed as described in HMAC Request Signing and Key Pairs.

The Admin API uses a base URL with the following format: https://{tenantId}.api.zephr.com

Note: If you have multiple tenants, the current tenant ID is shown in a blue box in the top right of the Admin Console. If you have a single site, you can find the tenant ID by navigating to your site domains. To do this, select Sites from the Delivery menu, select your site, and then click the Site Domains button. The tenant ID is the first part of the domain. For example, if the domain is news-paper.cdn.zephr.com, the tenant ID is news.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api
https://{tenantId}.api.zephr.com

Account User

Contains operations on the Account User resource.

Operations

Admin User

Contains operations on the Admin User resource.

Operations

Bundle

Contains operations on the Bundle resource.

Operations

Cache Configurations

Contains operations on the Cache Configurations resource.

Operations

Cache Management

Cache Mangement.

Operations

Company

Actions on resource Company.

Operations

Component Library

Actions on resource Library Component.

Operations

Configuration

Blaize tenant configuration.

Operations

Credit

Actions on resource Credit.

Operations

Decision Engine

Operations

Email Templates

Actions on email templates.

Operations

Entitlement

Actions on resource Entitlement.

Operations

Feature Rules

Actions on resource Feature Rules.

Note: - Note: The APIs mentioned in this section support legacy Feature Rules only. Feature Rules created through the Admin Console (V4 Features) are stored in a different system and are not accessible through these APIs.

Operations

Form

Actions on resource Form.

Operations

Gifts

Operations

Grants

Actions on resource Grant.

Operations

Meter

Actions on resource Meter.

Operations

Products

Actions on resource Product.

Operations

Request Rules

Actions on resource Request Rules.

Operations

Session

Actions on resource Session.

Operations

Static Items

Actions on resource Static Item.

Operations

Third Party Authentication

Contains operations for the OAuth 2.0 Authorization Code Flow Token Exchange.

Operations

User Export

Operations

User Schema

Actions on resource User Schema.

Operations

Users

Contains operations on the User resource. Important: The Attributes object contains the custom-defined attributes for a user.

Operations

Inserts or updates a foreign key

Request

Inserts or updates the provided foreign key, if the supplied userId and key match.

Security
ZephrHmacHttp
Path
userIdstringrequired

Unique User identifier

Example: 3f589a2d-86cd-4b70-a5df-68dca75a3a21
keystringrequired

Foreign system key

Example: foreign_system_key
Bodyapplication/json
string
curl -i -X PUT \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/3f589a2d-86cd-4b70-a5df-68dca75a3a21/foreign-key/update/foreign_system_key \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK - Foreign key was successfully inserted or updated

List users

Request

Retrieves a list of users wrapped in the element "results".

Security
ZephrHmacHttp
Query
identifiers.email_addressstringrequired

Email address of the user to search for.

Example: identifiers.email_address=example@example.com
identifiers.usernamestringrequired

Username of the user to search for.

Example: identifiers.username=username
foreign_key.xxxstringrequired

Foreign key of the user to search for. The foreign system is parsed as the remainder of the parameter key name following 'foreign_id.'

Example: foreign_key.xxx=123abc
searchstringrequired

Performs a general search for the specified value across multiple fields, including attributes.

Example: search=abc
search_by_attributesArray of objects(search_by_attributes)

Several attribute filters can be specified to search for users with particular attributes. It needs to be Base64 and URL encoded.

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users?identifiers.email_address=example%40example.com&identifiers.username=username&foreign_key.xxx=123abc&search=abc&search_by_attributes=slug%3Dsubscriber-id%26operator%3Dis%26value%3D123456%26from%3D2025-01-01%26to%3D2025-06-01' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
resultsArray of objects(user-response)
Response
application/json
{
  "results": [
    { … }
  ]
}

Create a user

Request

Creates a new user.

Security
ZephrHmacHttp
Bodyapplication/json
validatorsobject(legacy-validators)

Validators are not required for user creation, users created without validators won't be able to sign into Zephr unless they follow a password reset flow, or being mapped as shadow users identified by a JWT.

identifiersobject(identifiers)required
identifiers.​email_addressstring
Example: "joe.blow@company.com"
attributesobject(attributes)
accountMembershipCodestring
email_verifiedboolean
last_loginstring
tracking_idstring
registeredstring
registration_stateobject
registration_tenantstring
session_limitinteger
foreign_keysArray of objects
product_sharing_idstring
created_atstring
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "123456789ABCD",
    "identifiers": {
      "email_address": "joe.blow@company.com"
    },
    "attributes": {
      "first_name": "Joe",
      "surname": "Blow",
      "email_verified": true
    }
  }'

Responses

Created

Bodyapplication/json
resultsArray of objects(user-response)
Response
application/json
{
  "data": {
    "user_id": "123456789ABCD",
    "identifiers": { … },
    "attributes": { … },
    "email_verified": true
  }
}

V4 Session

Actions on resource Session.

Operations

Webhook

Actions on resource Webhook.

Operations

Account

Actions on resource Account.

Operations

Health Check

Actions on Health checks.

Operations

System Resources

Actions on system resources.

Operations

External Templates

External Templates.

Accounts

Operations

Request Rules Version

Operations

Fetch external template

Request

Fetch External Template

Security
ZephrHmacHttp
Path
templateConfigIdstringrequired

Unique External Template identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/zephr/public/template-components/v1/template-components/{templateConfigId}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
string
Response
application/json
[
  "The template the-value::!"
]

Pages

Operations

Dynamic Offer Promo code redemption

Operations

Subscription

Operations