Skip to content
Public API reference
/
/
Updates the attributes fo...

Public API Reference (2025-07-30)

The Zephr Public API provides common client-side actions tied to a session cookie. Unlike the Admin API, neither users nor other resources can be dereferenced; the only data that can be accessed is owned by the user who is currently signed-in. This design is used to protect other users from malicious attacks.

You can find the base URL for the Public API 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 base URL is the Live domain.

Zephr forms use the Public API by default, with relative URLs based on the base URL.

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

Authentication

Operations

Braintree Payments

Operations

Browser Feature Transformations

Operations

Decision Engine

Operations

Dynamic Offer Decision Engine

Operations

Dynamic Offer Promo Code Decision

Operations

OAuth Flow

Operations

Payments

Operations

Product Sharing

Operations

SDK Feature Decision Engine

Operations

Sessions

Operations

Stripe Payments

Operations

Third-Party Authentication

This section contains the API operations for the OAuth 2.0 Authorization Code Flow.

Operations

User

Operations

Updates the attributes for an authenticated user in the Zephr user store.

Request

Updates the attributes for an authenticated user in the Zephr user store. The behaviour for the POST and PATCH methods on this endpoint is identical. The provided attributes are saved for the user. Any new attributes are added. Any existing attributes with the same keys are updated. Any existing attributes with different keys remain unchanged. The request can also include an optional 'blaize-validator' property to authenticate a previously partially registered user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: blaize_session=57685913-7365-4dae-a425-1c2c2f72cc0
Bodyapplication/json
blaize-validatorstring

An optional password that can be used to validate an outstanding partial registration.

property name*string or number or integer or booleanadditional property
Any of:
string
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/profile \
  -H 'Content-Type: application/json' \
  -H 'cookie: blaize_session=57685913-7365-4dae-a425-1c2c2f72cc0' \
  -b blaize_session=57685913-7365-4dae-a425-1c2c2f72cc0

Responses

OK. The message 'User profile updated' is displayed, to confirm that the user attributes were successfully saved.

Headers
Set-Cookiestring

If a 'blaize-validator' was supplied and successfully used to authenticate the request then the response will include blaize session cookies.

Updates the attributes for an authenticated user in the Zephr user store.

Request

Updates the attributes for an authenticated user in the Zephr user store. The behaviour for the POST and PATCH methods on this endpoint is identical. The provided attributes are saved for the user. Any new attributes are added. Any existing attributes with the same keys are updated. Any existing attributes with different keys remain unchanged. The request can also include an optional 'blaize-validator' property to authenticate a previously partially registered user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: blaize_session=57685913-7365-4dae-a425-1c2c2f72cc0
Bodyapplication/json
blaize-validatorstring

An optional password that can be used to validate an outstanding partial registration.

property name*string or number or integer or booleanadditional property
Any of:
string
curl -i -X PATCH \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/profile \
  -H 'Content-Type: application/json' \
  -H 'cookie: blaize_session=57685913-7365-4dae-a425-1c2c2f72cc0' \
  -b blaize_session=57685913-7365-4dae-a425-1c2c2f72cc0

Responses

OK. The message 'User profile updated', to confirm that the user attributes were successfully saved.

Headers
Set-Cookiestring

If a 'blaize-validator' was supplied and successfully used to authenticate the request then the response will include blaize session cookies.

Retrieve Extended Profile

Request

Extended Profile is used to store additional user information that is not part of the core profile. This endpoint is designed to be used for retrieving the user's Extended Profile. The body can be any valid JSON.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Path
appIdstringrequired

Unique, caller-provided path parameter that represents the context under which the end user's data is stored within a tenant. This cannot start with '_restricted'.

Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/profile/{appId}' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)'

Responses

OK

Bodyapplication/json
One of:
object
Response
application/json
{
  "first_name": "John",
  "last_name": "Doe",
  "user_details": {
    "email_address": "john.doe@zuora.com",
    "employment": { … },
    "consent_prefs": { … },
    "interests": [ … ]
  }
}

V4 Gifts

Create a Gift resource for V4. Gifts can be used to provide access to a particular URL for one session only by appending a gift token ID to the URL as the gift path parameter.

Operations

Web Analytics

Operations

Zephr Features

Operations

Component Library

Operations

Change the Stripe subscription price

Request

Generates a new preview of the price that Stripe will charge the customer if they create a new subscription for the specified plan. Note: This method does not create any entities in Stripe and does not result in any payments being made.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Path
externalIdstringrequired
Bodyapplication/json
plan_idstring
curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/stripe/subscriptions/{externalId}/change-previews' \
  -H 'Content-Type: application/json' \
  -b blaize_session=YOUR_API_KEY_HERE \
  -d '{
    "plan_id": "string"
  }'

Responses

OK

Bodyapplication/json
totalnumber

The total amount the user will be initially charged for the subscription in the relevant currency's lowest denomination (e.g. pence), i.e. for a monthly subscription, the first month's cost.

Example: 5000
sub_totalnumber

The total amount minus tax for the initial charge in the relevant currency's lowest denomination (e.g. pence).

Example: 4500
Response
application/json
{
  "total": 5000,
  "sub_total": 4500
}

Oauth2 Access Token

Operations

Subscription

Operations