Skip to content
/User Schema

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

Retrieve a user schema

Request

Retrieves a user Schema.

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

Responses

OK

Bodyapplication/jsonArray [
slugstring
Example: "slug1"
visibilitystring
Value"PUBLIC"
Example: "PUBLIC"
contextstring
Example: "slug1"
labelstring
Example: "Test"
internal-descriptionstring
Example: "This is for testing"
public-descriptionstring
Example: "Please provide some info"
requiredboolean
validation-expressionstring
Example: "test"
input-typestring
Enum"text""color""number""range""time""datetime""date""week""month""email"
Example: "text"
select-optionsstring
Example: "null"
range-startnumber
range-endnumber
Example: 100
range-stepnumber
Example: 5
decision-pointboolean
publicly-writableboolean
form-useboolean
unitstring
Example: "unit"
unit-positionstring
Enum"leading""trailing"
value-precisionnumber
stat-directionstring
Enum"ascending""descending"
]
Response
application/json
[
  {
    "slug": "slug1",
    "label": "Test",
    "internal-description": "This is for testing",
    "public-description": "Please provide some info",
    "required": false,
    "decision-point": false,
    "validation-expression": "test",
    "input-type": "text",
    "select-options": "null",
    "range-start": 0,
    "range-end": 100,
    "range-step": 5
  }
]

Retrieve a schema slug

Request

Retrieves a schema slug.

Security
ZephrHmacHttp
Path
slugstringrequired

Unique identifier

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

Responses

OK

Bodyapplication/json
slugstring
Example: "slug1"
visibilitystring
Value"PUBLIC"
Example: "PUBLIC"
contextstring
Example: "slug1"
labelstring
Example: "Test"
internal-descriptionstring
Example: "This is for testing"
public-descriptionstring
Example: "Please provide some info"
requiredboolean
validation-expressionstring
Example: "test"
input-typestring
Enum"text""color""number""range""time""datetime""date""week""month""email"
Example: "text"
select-optionsstring
Example: "null"
range-startnumber
range-endnumber
Example: 100
range-stepnumber
Example: 5
decision-pointboolean
publicly-writableboolean
form-useboolean
unitstring
Example: "unit"
unit-positionstring
Enum"leading""trailing"
value-precisionnumber
stat-directionstring
Enum"ascending""descending"
Response
application/json
{
  "slug": "slug1",
  "visibility": "PUBLIC",
  "context": "slug1",
  "label": "Test",
  "internal-description": "This is for testing",
  "public-description": "Please provide some info",
  "required": true,
  "validation-expression": "test",
  "input-type": "text",
  "select-options": "null",
  "range-start": 0,
  "range-end": 100,
  "range-step": 5,
  "decision-point": true,
  "publicly-writable": true,
  "form-use": true,
  "unit": "unit",
  "unit-position": "leading",
  "value-precision": 0,
  "stat-direction": "ascending"
}

Delete a schema slug

Request

Deletes a schema slug.

Security
ZephrHmacHttp
Path
slugstringrequired

Unique identifier

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

Responses

OK

Body*/*
messagestring
Example: "Field removed from schema successfully"

Save a schema slug

Request

Saves a schema slug.

Security
ZephrHmacHttp
Path
slugstringrequired

Unique identifier

Bodyapplication/json
slugstring
Example: "slug1"
visibilitystring
Value"PUBLIC"
Example: "PUBLIC"
contextstring
Example: "slug1"
labelstring
Example: "Test"
internal-descriptionstring
Example: "This is for testing"
public-descriptionstring
Example: "Please provide some info"
requiredboolean
validation-expressionstring
Example: "test"
input-typestring
Enum"text""color""number""range""time""datetime""date""week""month""email"
Example: "text"
select-optionsstring
Example: "null"
range-startnumber
range-endnumber
Example: 100
range-stepnumber
Example: 5
decision-pointboolean
publicly-writableboolean
form-useboolean
unitstring
Example: "unit"
unit-positionstring
Enum"leading""trailing"
value-precisionnumber
stat-directionstring
Enum"ascending""descending"
curl -i -X PUT \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/schema/users/{slug}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "slug": "slug1",
    "visibility": "PUBLIC",
    "context": "slug1",
    "label": "Test",
    "internal-description": "This is for testing",
    "public-description": "Please provide some info",
    "required": true,
    "validation-expression": "test",
    "input-type": "text",
    "select-options": "null",
    "range-start": 0,
    "range-end": 100,
    "range-step": 5,
    "decision-point": true,
    "publicly-writable": true,
    "form-use": true,
    "unit": "unit",
    "unit-position": "leading",
    "value-precision": 0,
    "stat-direction": "ascending"
  }'

Responses

Updated

Response
No content

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

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