Skip to content
/Account

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

V4 Session

Actions on resource Session.

Operations

Webhook

Actions on resource Webhook.

Operations

Account

Actions on resource Account.

Operations

List accounts

Request

Retrieves a paginated list of accounts in results according to the passed in rpp, page and search parameters alongside the total number of items matching the search query (total).

Security
ZephrHmacHttp
Query
rppnumber

The number of results per page you want to retrieve.

Default 10
Example: rpp=15
pagenumber

The page number for which you want to retrieve results.

Default 10
Example: page=15
searchstring

The search query that searches accounts by their names

Example: search=My account
curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts?rpp=15&page=15&search=My+account' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - Accounts have been retrieved successfully

Bodyapplication/json
resultsArray of objects(response_simple_accountbody)
totalnumber

The total number of items out of which only a subset was returned in the paginated results.

Example: 30
Response
application/json
{
  "results": [
    { … }
  ],
  "total": 20
}

Create an account

Request

Creates an account.

Security
ZephrHmacHttp
Bodyapplication/jsonrequired

Description

company_idstring
Example: "123456789ABCD"
namestring
Example: "Account name"
number_of_seatsnumber
Example: 5
allow_oversubscriptionboolean
Example: true
notify_when_account_oversubscribedboolean
Example: true
notify_on_each_registration_when_account_is_oversubscribedboolean
Example: true
registration_codestring
Example: "Registration code"
on_premises_ipsstring

A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account.

Example: "125.124.143.24"
premises_tagsstring

(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine.

Example: "[\"gold-tier\", \"university\"]"
session_limitnumber

The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used.

Example: 10
session_limit_behaviourstring

One of "PREVENT_LOGIN" or "DELETE_OLDEST_SESSIONS". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions.

Example: "PREVENT_LOGIN"
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_id": "123456789ABCD",
    "name": "Account name",
    "number_of_seats": 5,
    "allow_oversubscription": true,
    "notify_when_account_oversubscribed": true,
    "notify_on_each_registration_when_account_is_oversubscribed": true,
    "registration_code": "Registration code",
    "on_premises_ips": "125.124.143.24",
    "premises_tags": "[\"gold-tier\", \"university\"]",
    "session_limit": 10,
    "session_limit_behaviour": "PREVENT_LOGIN"
  }'

Responses

Created

Retrieve an account

Request

Retrieves an account.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Account identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
company_idstring
namestring
number_of_seatsnumber
allow_oversubscriptionboolean
notify_when_account_oversubscribedboolean
notify_on_each_registration_when_account_is_oversubscribedboolean
registration_codestring
ip_addressesstring
registration_domainsstring
email_addressstring
on_premises_ipsstring

A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account.

premises_tagsstring

(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine.

session_limitnumber

The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used.

session_limit_behaviourstring

One of "PREVENT_LOGIN" or "DELETE_OLDEST_SESSIONS". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions.

brandingobject
Response
application/json
{
  "company_id": "123456789ABCD",
  "name": "Account name",
  "number_of_seats": 5,
  "allow_oversubscription": true,
  "notify_when_account_oversubscribed": true,
  "notify_on_each_registration_when_account_is_oversubscribed": true,
  "registration_code": "Registration code",
  "on_premises_ips": "125.124.143.24",
  "premises_tags": "[\"gold-tier\", \"university\"]",
  "session_limit": 10,
  "session_limit_behaviour": "PREVENT_LOGIN"
}

Delete an account

Request

Deletes an account.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Account identifier

curl -i -X DELETE \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Update an account

Request

Updates an account.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Account identifier

Bodyapplication/jsonrequired

Description

company_idstring
Example: "123456789ABCD"
namestring
Example: "Account name"
number_of_seatsnumber
Example: 5
allow_oversubscriptionboolean
Example: true
notify_when_account_oversubscribedboolean
Example: true
notify_on_each_registration_when_account_is_oversubscribedboolean
Example: true
registration_codestring
Example: "Registration code"
on_premises_ipsstring

A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account.

Example: "125.124.143.24"
premises_tagsstring

(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine.

Example: "[\"gold-tier\", \"university\"]"
session_limitnumber

The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used.

Example: 10
session_limit_behaviourstring

One of "PREVENT_LOGIN" or "DELETE_OLDEST_SESSIONS". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions.

Example: "PREVENT_LOGIN"
curl -i -X PUT \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_id": "123456789ABCD",
    "name": "Account name",
    "number_of_seats": 5,
    "allow_oversubscription": true,
    "notify_when_account_oversubscribed": true,
    "notify_on_each_registration_when_account_is_oversubscribed": true,
    "registration_code": "Registration code",
    "on_premises_ips": "125.124.143.24",
    "premises_tags": "[\"gold-tier\", \"university\"]",
    "session_limit": 10,
    "session_limit_behaviour": "PREVENT_LOGIN"
  }'

Responses

Created

Retrieve an account for V4

Request

Retrieves an V4 account.

Security
ZephrHmacHttp
Path
account_idstringrequired

Unique Account identifier V4

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/accounts/{account_id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
company_idstring
namestring
number_of_seatsnumber
allow_oversubscriptionboolean
notify_when_account_oversubscribedboolean
notify_on_each_registration_when_account_is_oversubscribedboolean
registration_codestring
ip_addressesstring
registration_domainsstring
email_addressstring
on_premises_ipsstring

A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account.

premises_tagsstring

(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine.

session_limitnumber

The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used.

session_limit_behaviourstring

One of "PREVENT_LOGIN" or "DELETE_OLDEST_SESSIONS". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions.

brandingobject
Response
application/json
{
  "company_id": "123456789ABCD",
  "name": "Account name",
  "number_of_seats": 5,
  "allow_oversubscription": true,
  "notify_when_account_oversubscribed": true,
  "notify_on_each_registration_when_account_is_oversubscribed": true,
  "registration_code": "Registration code",
  "on_premises_ips": "125.124.143.24",
  "premises_tags": "[\"gold-tier\", \"university\"]",
  "session_limit": 10,
  "session_limit_behaviour": "PREVENT_LOGIN"
}

List accounts for v4

Request

Retrieves a list of accounts for V4.

Security
ZephrHmacHttp
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/accounts \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
resultsArray of objects(response_accountbody)

A list of account objects.

Response
application/json
{
  "results": [
    { … }
  ]
}

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