{"items":[{"type":"separator","label":"GET STARTED"},{"type":"link","fsPath":"zephr-api-reference/zephr-api-introduction.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/zephr-api-reference/zephr-api-introduction","routeSlug":"/zephr-api-reference/zephr-api-introduction"},{"type":"separator","label":"ENDPOINTS"},{"type":"group","label":"Admin API reference","items":[{"type":"group","label":"v5 API","items":[{"type":"link","label":"v5 Admin API reference","link":"/zephr-api-reference/zephr-v5-admin-openapi","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi"},{"type":"separator","label":"Accounts"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management","items":[{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/createaccount","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/createaccount","metadata":{"seo":{"title":"Create an account","description":"Creates a new account for your organization with registration settings, seat allocations, session limits, and access controls. Use this to set up B2B membership accounts or to share entitlements across a group of users."}},"httpPath":"/v5/accounts"},{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/listaccounts","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/listaccounts","metadata":{"seo":{"title":"List accounts","description":"Retrieves a list of your accounts. If you include pagination or search parameters in your request, the response is returned as a paginated collection with results, links, and meta. If you don't include these parameters, the response is returned simply as a plain array of accounts."}},"httpPath":"/v5/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/getaccount","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/getaccount","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieves an account by accountId. It includes seat usage, registrationsettings, and access-control configuration."}},"httpPath":"/v5/accounts/{accountId}"},{"label":"Update an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/updateaccount","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/updateaccount","metadata":{"seo":{"title":"Update an account","description":"Updates an existing account using its accountId. You only need to providethe fields you want to modify; any fields not included in the request willretain their current values."}},"httpPath":"/v5/accounts/{accountId}"},{"label":"Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/deleteaccount","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/deleteaccount","metadata":{"seo":{"title":"Delete an account","description":"Deletes an account identified by accountId. Associated account grants andmembership relationships are removed according to the tenant configuration."}},"httpPath":"/v5/accounts/{accountId}"},{"label":"List user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/listuseraccounts","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/accounts-management/listuseraccounts","metadata":{"seo":{"title":"List user accounts","description":"Retrieves the accounts that the specified user belongs to, including the user's role for each account."}},"httpPath":"/v5/users/{userId}/accounts"}]},{"type":"separator","label":"Cache"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/cache-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/cache-management","items":[{"label":"Evict cached origin requests for a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/cache-management/evictorigincacheforsite","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/cache-management/evictorigincacheforsite","metadata":{"seo":{"title":"Evict cached origin requests for a given site","description":"Evicts all origin cache entries for the given site that match the path pattern provided in the request body. Provide .* as the path pattern to evict all paths for the site."}},"httpPath":"/v5/cache-management/evict-origin/{site}"}]},{"type":"separator","label":"Companies"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management","items":[{"label":"Create a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/createcompany","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/createcompany","metadata":{"seo":{"title":"Create a company","description":"Creates a company using the details you provide in the request body. Companies let you group related accounts together, making it easier to organize your B2B customer structure and report across accounts."}},"httpPath":"/v5/companies"},{"label":"List companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/listcompanies","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/listcompanies","metadata":{"seo":{"title":"List companies","description":"Retrieves companies. The response returns a results array along with links and meta for pagination. Use the rpp, page, and search query parameters to page through companies and filter them by name."}},"httpPath":"/v5/companies"},{"label":"Retrieve a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/getcompany","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/getcompany","metadata":{"seo":{"title":"Retrieve a company","description":"Retrieves company information for the company specified by the companyId parameter."}},"httpPath":"/v5/companies/{companyId}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/updatecompany","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/companies-management/updatecompany","metadata":{"seo":{"title":"Update a company","description":"Updates the company"}},"httpPath":"/v5/companies/{companyId}"}]},{"type":"separator","label":"Grants"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management","items":[{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/createaccountgrant","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/createaccountgrant","metadata":{"seo":{"title":"Create an account grant","description":"Creates a grant for the account identified by accountId. Account grantsassign entitlements that apply to account members."}},"httpPath":"/v5/accounts/{accountId}/grants"},{"label":"List account grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/listaccountgrants","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/listaccountgrants","metadata":{"seo":{"title":"List account grants","description":"Retrieves the account grants for the account identified by accountId, returning an empty list if the account has none."}},"httpPath":"/v5/accounts/{accountId}/grants"},{"label":"Retrieve an account grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/getaccountgrant","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/getaccountgrant","metadata":{"seo":{"title":"Retrieve an account grant","description":"Retrieves a single account grant, if the supplied accountId and grantId match."}},"httpPath":"/v5/accounts/{accountId}/grants/{grantId}"},{"label":"Delete an account grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/deleteaccountgrant","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/deleteaccountgrant","metadata":{"seo":{"title":"Delete an account grant","description":"Deletes the account grant identified by grantId for the account identified by accountId."}},"httpPath":"/v5/accounts/{accountId}/grants/{grantId}"},{"label":"Create a user grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/createusergrant","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/createusergrant","metadata":{"seo":{"title":"Create a user grant","description":"Creates a grant for the user identified by userId. A grant assigns anentitlement (for example a product, bundle, or feature) for an optionaltime window."}},"httpPath":"/v5/users/{userId}/grants"},{"label":"List user grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/listusergrants","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/listusergrants","metadata":{"seo":{"title":"List user grants","description":"Retrieves grants for the user identified by userId. Use the active queryparameter to include only currently active grants."}},"httpPath":"/v5/users/{userId}/grants"},{"label":"Retrieve a user grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/getusergrant","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/getusergrant","metadata":{"seo":{"title":"Retrieve a user grant","description":"Retrieves a single grant for the user identified by userId andgrantId."}},"httpPath":"/v5/users/{userId}/grants/{grantId}"},{"label":"Delete a user grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/deleteusergrant","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/grants-management/deleteusergrant","metadata":{"seo":{"title":"Delete a user grant","description":"Deletes the user grant identified by grantId for the user identified by userId."}},"httpPath":"/v5/users/{userId}/grants/{grantId}"}]},{"type":"separator","label":"Products"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/products-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/products-management","items":[{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/createproduct","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/createproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a product with the details specified in the request body. The product ID is randomly generated and included in the URI returned on success."}},"httpPath":"/v5/products"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/listproducts","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/listproducts","metadata":{"seo":{"title":"List products","description":"Retrieves all configured products. The response wraps the list in a results field, with each product's entitlement, payment mapping, JWT mapping, and sharing limit details included."}},"httpPath":"/v5/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/getproduct","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/getproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves a single product. The product is identified by the productId path parameter."}},"httpPath":"/v5/products/{productId}"},{"label":"Create or update a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/updateproduct","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/updateproduct","metadata":{"seo":{"title":"Create or update a product","description":"Updates the product identified by productId. If no product exists with that ID, a new one is created. Otherwise, the existing product is modified."}},"httpPath":"/v5/products/{productId}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/deleteproduct","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/products-management/deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Deletes a product. The product is identified by the productId path parameter."}},"httpPath":"/v5/products/{productId}"}]},{"type":"separator","label":"Promo Codes"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management","items":[{"label":"Activate a promo code definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management/activatepromocodedefinition","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management/activatepromocodedefinition","metadata":{"seo":{"title":"Activate a promo code definition","description":"Activates a promo code definition so that its codes can be redeemed."}},"httpPath":"/v5/promo-codes/definitions/{definitionId}/activate"},{"label":"List promo codes for a promo code definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management/listpromocodesfordefinition","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management/listpromocodesfordefinition","metadata":{"seo":{"title":"List promo codes for a promo code definition","description":"Lists promo codes configured for the promo code definition identified bydefinitionId."}},"httpPath":"/v5/promo-codes/definitions/{definitionId}/promo-codes"},{"label":"Create promo code redemptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management/createpromocoderedemptions","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/promo-codes-management/createpromocoderedemptions","metadata":{"seo":{"title":"Create promo code redemptions","description":"Creates redemptions for promo codes configured in the Zephr console. Returns a list of redemption results for each promo code."}},"httpPath":"/v5/promo-codes/redemptions"}]},{"type":"separator","label":"Resources"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management","items":[{"label":"List resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/listresources","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/listresources","metadata":{"seo":{"title":"List resources","description":"Retrieves system resources wrapped in the element results, including each resource slug, label, type, language, and stored content."}},"httpPath":"/v5/resources"},{"label":"Retrieve a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/getresource","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/getresource","metadata":{"seo":{"title":"Retrieve a resource","description":"Retrieves a system resource by resourceId, including metadata used tomanage shared configuration assets."}},"httpPath":"/v5/resources/{resourceId}"},{"label":"Update system resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/updateresource","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/updateresource","metadata":{"seo":{"title":"Update system resource","description":"Updates a system resource identified by resourceId with the suppliedmetadata."}},"httpPath":"/v5/resources/{resourceId}"},{"label":"Retrieve the resource content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/getresourcecontent","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/getresourcecontent","metadata":{"seo":{"title":"Retrieve the resource content","description":"Retrieves raw system resource content by provided resourceId.For Data Layer system resources, configuration must include exactly one field."}},"httpPath":"/v5/resources/{resourceId}/content"},{"label":"Update system resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/updateresourcecontent","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/resources-management/updateresourcecontent","metadata":{"seo":{"title":"Update system resource","description":"Updates the raw content of a system resource identified byresourceId."}},"httpPath":"/v5/resources/{resourceId}/content"}]},{"type":"separator","label":"Sessions"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management","items":[{"label":"Create an anonymous session under a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/createanonymoussessionundergivensite","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/createanonymoussessionundergivensite","metadata":{"seo":{"title":"Create an anonymous session under a given site","description":"Creates an anonymous session for the specified site. Anonymous sessions are useful for tracking pre-authentication activity, such as metering."}},"httpPath":"/v5/anonymous-sessions/{site}"},{"label":"Create a new session under a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/createnewsessionundergivensite","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/createnewsessionundergivensite","metadata":{"seo":{"title":"Create a new session under a given site","description":"Creates a new authenticated session for the supplied user on the specified site. The response includes session identifiers used by subsequent session lookup and delete operations."}},"httpPath":"/v5/sessions/{site}"},{"label":"Retrieve a session under a given site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/lookupsessionundergivensite","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/lookupsessionundergivensite","metadata":{"seo":{"title":"Retrieve a session under a given site","description":"This endpoint allows you to access specific session details for a particular site.By providing the unique identifiers for the site and the session, you can retrieve detailed information about that session.This information can include the session's start time, end time, current status, and any associated user data.The exact content of the response will depend on the specific session and site identifiers provided in the request."}},"httpPath":"/v5/sessions/{site}/{sessionId}"},{"label":"Delete a session under a given site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/deletesessionundergivensite","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/sessions-management/deletesessionundergivensite","metadata":{"seo":{"title":"Delete a session under a given site","description":"Deletes a specific session for a given site. You need to provide the unique identifiers for the site and the session. This operation is useful when you want to manually end a session before it naturally expires."}},"httpPath":"/v5/sessions/{site}/{sessionId}"}]},{"type":"separator","label":"User Export"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-export-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-export-management","items":[{"label":"Create a user export job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-export-management/createuserexportjob","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-export-management/createuserexportjob","metadata":{"seo":{"title":"Create a user export job","description":"Creates an asynchronous user export job for users who match the providedfilter parameters."}},"httpPath":"/v5/user-export-jobs"},{"label":"Retrieve a user export job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-export-management/getuserexportjob","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-export-management/getuserexportjob","metadata":{"seo":{"title":"Retrieve a user export job","description":"Retrieves the status and details for a user export job identified byjobId. When complete, the response includes information needed to obtainthe export output."}},"httpPath":"/v5/user-export-jobs/{jobId}"}]},{"type":"separator","label":"Users"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-management","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/listusers","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/listusers","metadata":{"seo":{"title":"List users","description":"Retrieves a paginated list of users. The response wraps the list in a results field. Filter results by identifiers, foreign keys, a general search value, or Base64-encoded attribute criteria. When multiple filters are supplied, they are combined to narrow the result set."}},"httpPath":"/v5/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/createuser","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/createuser","metadata":{"seo":{"title":"Create a user","description":"Creates a new user with the supplied identifiers, attributes, and optionalcredentials. The attributes object contains custom-defined fields fromthe user schema."}},"httpPath":"/v5/users"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/getuser","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/getuser","metadata":{"seo":{"title":"Retrieve a user","description":"Retrieves the user identified by userId, including their identifiers, attributes, foreign keys, and registration metadata."}},"httpPath":"/v5/users/{userId}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/deleteuser","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-management/deleteuser","metadata":{"seo":{"title":"Delete a user","description":"Deletes a user by userId and removes associated user data according totenant configuration."}},"httpPath":"/v5/users/{userId}"}]},{"type":"group","label":"Bulk Creation","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs","items":[{"label":"Create users in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs/createbulkusers","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs/createbulkusers","metadata":{"seo":{"title":"Create users in bulk","description":"Submits an asynchronous job to create multiple users. Each entry in users accepts thesame fields as POST /v5/users, including identifiers, validators, attributes, foreignkeys, registration details, and account membership."}},"httpPath":"/v5/users/create-jobs"},{"label":"List bulk creation jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs/listbulkusercreatejobs","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs/listbulkusercreatejobs","metadata":{"seo":{"title":"List bulk creation jobs","description":"Returns bulk user creation jobs for the tenant, including status and outcome counts when available."}},"httpPath":"/v5/users/create-jobs"},{"label":"Get bulk creation job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs/retrievebulkusercreatejob","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-create-jobs/retrievebulkusercreatejob","metadata":{"seo":{"title":"Get bulk creation job status","description":"Returns the status of a bulk user creation job. Once processing completes, the response includes success and failure counts, along with details for any users that could not be created."}},"httpPath":"/v5/users/create-jobs/{jobId}"}]},{"type":"group","label":"Bulk Updates","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs","items":[{"label":"Apply bulk user actions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs/updatebulkusers","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs/updatebulkusers","metadata":{"seo":{"title":"Apply bulk user actions","description":"Submits an asynchronous job to perform bulk actions on existing users. Supportedaction type values are set-attribute, delete-user, and create-user-grant."}},"httpPath":"/v5/users/update-jobs"},{"label":"List bulk update jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs/listbulkuserupdatejobs","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs/listbulkuserupdatejobs","metadata":{"seo":{"title":"List bulk update jobs","description":"Returns bulk user creation and update jobs for the tenant, including each job's status and its success/failure counts once processing completes."}},"httpPath":"/v5/users/update-jobs"},{"label":"Get bulk update job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs/retrievebulkuserupdatejob","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-update-jobs/retrievebulkuserupdatejob","metadata":{"seo":{"title":"Get bulk update job status","description":"Returns the status of a bulk user update job. Once processing completes, the response includes success and failure counts, along with per-user action results."}},"httpPath":"/v5/users/update-jobs/{jobId}"}]},{"type":"group","label":"Credentials","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials","items":[{"label":"Start a password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/startpasswordreset","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/startpasswordreset","metadata":{"seo":{"title":"Start a password reset","description":"To reset a user's password, you must first send a POST request to trigger an email containing a link the user clicks to confirm they requested the change."}},"httpPath":"/v5/users/reset"},{"label":"Update password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/updateuserpassword","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/updateuserpassword","metadata":{"seo":{"title":"Update password","description":"Sets the user's password to the plain-text value supplied in the requestbody. Use this for admin-initiated password updates; for end-user resets,prefer POST /v5/users/reset."}},"httpPath":"/v5/users/{userId}/password"},{"label":"Start an email address update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/startemailaddressupdate","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/startemailaddressupdate","metadata":{"seo":{"title":"Start an email address update","description":"Starts an email address update. If Require Email Verification is enabled: the user must verify the new address before the update completes. If Email Change Override is also enabled, the verification email is sent to the new address. Otherwise, the verification email is sent to the old address. If Require Email Verification is not enabled: the new email address is set immediately. If the provided email address is blank and the user has a username, the email address is deleted. If the provided email address is blank and the user does not have a username, the request fails with a 400 response."}},"httpPath":"/v5/users/{userId}/update-email"},{"label":"Update username","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/updateusername","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-credentials/updateusername","metadata":{"seo":{"title":"Update username","description":"Updates a user's username. Provide a new value, or set it to null to remove the username, provided the user has an email address on file."}},"httpPath":"/v5/users/{userId}/update-username"}]},{"type":"group","label":"Profile","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile","items":[{"label":"Retrieve the user extended profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile/getuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile/getuserprofile","metadata":{"seo":{"title":"Retrieve the user extended profile","description":"Retrieves a user's extended profile and additional information stored outside the core profile. The response body can be any valid JSON object or array, depending on what was previously stored."}},"httpPath":"/v5/users/{userId}/profile/{appId}"},{"label":"Update the user extended profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile/updateuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile/updateuserprofile","metadata":{"seo":{"title":"Update the user extended profile","description":"Extended Profile stores additional user information that is not part of the core profile. Updates the user's Extended Profile. The request body can be any valid JSON object or array."}},"httpPath":"/v5/users/{userId}/profile/{appId}"},{"label":"Delete the user extended profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile/deleteuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-profile/deleteuserprofile","metadata":{"seo":{"title":"Delete the user extended profile","description":"Extended Profile stores additional user information that is not part of the core profile. Deletes the user's Extended Profile."}},"httpPath":"/v5/users/{userId}/profile/{appId}"}]},{"type":"group","label":"Foreign keys","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-foreign-keys","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-foreign-keys","items":[{"label":"Delete a foreign key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-foreign-keys/deleteforeignkey","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-foreign-keys/deleteforeignkey","metadata":{"seo":{"title":"Delete a foreign key","description":"Deletes the foreign key identified by userId, system, and key."}},"httpPath":"/v5/users/{userId}/foreign-key/{system}/{key}"},{"label":"Inserts or updates a foreign key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-foreign-keys/upsertforeignkey","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-foreign-keys/upsertforeignkey","metadata":{"seo":{"title":"Inserts or updates a foreign key","description":"Inserts or updates a foreign key value for the supplied user and foreign system. The path parameter key identifies the foreign system; the request body contains the foreign key value. Returns 409 if that foreign key value is already associated with another user. Returns 400 (not 404) when the supplied user does not exist."}},"httpPath":"/v5/users/{userId}/foreign-key/update/{key}"}]},{"type":"group","label":"Attributes","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes","items":[{"label":"Update user attributes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes/updateuserattributes","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes/updateuserattributes","metadata":{"seo":{"title":"Update user attributes","description":"Updates a user's attributes. Any existing attributes not included in the payload remain unchanged."}},"httpPath":"/v5/users/{userId}/attributes"},{"label":"Update all user attributes","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes/replaceuserattributes","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes/replaceuserattributes","metadata":{"seo":{"title":"Update all user attributes","description":"Replaces all of a user's attributes with those in the request payload. To update specific attributes without affecting the rest, use PATCH instead."}},"httpPath":"/v5/users/{userId}/attributes"},{"label":"Update user attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes/patchuserattributes","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-attributes/patchuserattributes","metadata":{"seo":{"title":"Update user attributes","description":"Updates a user's attributes. Any of the user's existing attributes not specified in the payload will be left in place."}},"httpPath":"/v5/users/{userId}/attributes"}]},{"type":"separator","label":"User Schema"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management","items":[{"label":"List user schema fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/listuserschemafields","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/listuserschemafields","metadata":{"seo":{"title":"List user schema fields","description":"Retrieves the tenant's user schema, which defines the custom attribute fields available on user profiles, including each field's label, validation rules, and visibility."}},"httpPath":"/v5/schema/users"},{"label":"Retrieve a user schema field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/getuserschemafield","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/getuserschemafield","metadata":{"seo":{"title":"Retrieve a user schema field","description":"Retrieves a single user schema field identified by slug."}},"httpPath":"/v5/schema/users/{slug}"},{"label":"Save user schema field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/updateuserschemafield","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/updateuserschemafield","metadata":{"seo":{"title":"Save user schema field","description":"Creates or updates the user schema field identified by slug, defining custom attribute metadata such as label, input type, validation, and visibility."}},"httpPath":"/v5/schema/users/{slug}"},{"label":"Delete a user schema field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/deleteuserschemafield","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/user-schema-management/deleteuserschemafield","metadata":{"seo":{"title":"Delete a user schema field","description":"Deletes the user schema field identified by slug. Existing user attribute values for the field are not automatically removed and must be cleaned up separately."}},"httpPath":"/v5/schema/users/{slug}"}]},{"type":"separator","label":"Webhooks"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management","items":[{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/createwebhook","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Creates a new webhook that sends configured events to a target URL."}},"httpPath":"/v5/webhooks"},{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/listwebhooks","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"Retrieves configured webhooks wrapped in the element results, including trigger, target, site, credential, and recent delivery error information."}},"httpPath":"/v5/webhooks"},{"label":"Retrieve a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/getwebhook","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/getwebhook","metadata":{"seo":{"title":"Retrieve a webhook","description":"Retrieves a webhook definition by webhookDefinitionId, including triggers, target URL, credential reference, site scope, and recent delivery error status."}},"httpPath":"/v5/webhooks/{webhookDefinitionId}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/updatewebhook","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Updates a webhook definition identified by webhookDefinitionId. Use thisto change triggers, the target URL, credentials, or site scope."}},"httpPath":"/v5/webhooks/{webhookDefinitionId}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/deletewebhook","routeSlug":"/zephr-api-reference/zephr-v5-admin-openapi/webhooks-management/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Deletes a webhook definition identified by webhookDefinitionId. Eventdelivery for that webhook stops after deletion."}},"httpPath":"/v5/webhooks/{webhookDefinitionId}"}]}]},{"type":"group","label":"v4 API","items":[{"type":"link","label":"v4 Admin API reference","link":"/zephr-api-reference/zephr-admin-api","routeSlug":"/zephr-api-reference/zephr-admin-api"},{"type":"group","label":"Account User","link":"/zephr-api-reference/zephr-admin-api/account-user","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user","items":[{"label":"List account users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusers","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusers","metadata":{"seo":{"title":"List account users","description":"Retrieves all the account users."}},"httpPath":"/v3/accounts/{account_id}/users"},{"label":"Retrieve an account user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/retrieveaccountuser","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/retrieveaccountuser","metadata":{"seo":{"title":"Retrieve an account user","description":"Retrieves an account user."}},"httpPath":"/v3/accounts/{account_id}/users/{user_id}"},{"label":"Delete an account user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/deleteaccountuser","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/deleteaccountuser","metadata":{"seo":{"title":"Delete an account user","description":"Deletes an account user."}},"httpPath":"/v3/accounts/{account_id}/users/{user_id}"},{"label":"Save or Create an account user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/saveaccountuser","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/saveaccountuser","metadata":{"seo":{"title":"Save or Create an account user","description":"Saves or Creates an account specified by account_id and user_id."}},"httpPath":"/v3/accounts/{account_id}/users/{user_id}"},{"label":"List account users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusersv4","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusersv4","metadata":{"seo":{"title":"List account users","description":"Retrieves all the account users, if the accountId has users."}},"httpPath":"/v4/accounts/{accountId}/grants"}]},{"type":"group","label":"Admin User","link":"/zephr-api-reference/zephr-admin-api/admin-user","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user","items":[{"label":"Create an admin user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/createadminuser","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/createadminuser","metadata":{"seo":{"title":"Create an admin user","description":"Creates a new admin user."}},"httpPath":"/v3/admin/users"},{"label":"Log in to an admin user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/loginadminuseraccount","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/loginadminuseraccount","metadata":{"seo":{"title":"Log in to an admin user account","description":"Logs in to an admin user account."}},"httpPath":"/v3/admin/login"},{"label":"Log out of the admin user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/logoutadminuseraccount","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/logoutadminuseraccount","metadata":{"seo":{"title":"Log out of the admin user account","description":"Logs out of the admin user account."}},"httpPath":"/v3/admin/logout"},{"label":"Issue a key pair","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/issuekeypair","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/issuekeypair","metadata":{"seo":{"title":"Issue a key pair","description":"Issues a new key pair for the admin user."}},"httpPath":"/v3/admin/users/{user_id}/keypairs"},{"label":"List access keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listaccesskeys","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listaccesskeys","metadata":{"seo":{"title":"List access keys","description":"Retrieves a list of access keys for the admin user."}},"httpPath":"/v3/admin/users/{user_id}/keypairs"},{"label":"Revoke a keypair","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/revokekeypair","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/revokekeypair","metadata":{"seo":{"title":"Revoke a keypair","description":"Revokes a keypair."}},"httpPath":"/v3/admin/users/{user_id}/keypairs/{access_key}"},{"label":"List user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listuserroles","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listuserroles","metadata":{"seo":{"title":"List user roles","description":"Retrieves the user roles an admin user is assigned."}},"httpPath":"/v3/admin/users/{user_id}/roles"},{"label":"List user roles by tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listusertenantroles","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listusertenantroles","metadata":{"seo":{"title":"List user roles by tenant","description":"Retrieves the admin user's roles by tenant."}},"httpPath":"/v3/admin/users/{user_id}/roles/{tenant}"},{"label":"Create admin user roles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/createadminrole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/createadminrole","metadata":{"seo":{"title":"Create admin user roles","description":"Creates admin user roles."}},"httpPath":"/v3/admin/roles"},{"label":"List admin user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listroles","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listroles","metadata":{"seo":{"title":"List admin user roles","description":"Retrieves the admin user roles by tenant."}},"httpPath":"/v3/admin/roles"},{"label":"Update an admin user role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/updaterole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/updaterole","metadata":{"seo":{"title":"Update an admin user role","description":"Updates an admin user role by ID."}},"httpPath":"/v3/admin/roles/{role_id}"},{"label":"Retrieve an admin user role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/getrole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/getrole","metadata":{"seo":{"title":"Retrieve an admin user role","description":"Retrieves an admin user role."}},"httpPath":"/v3/admin/roles/{role_id}"},{"label":"Delete an admin user role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/deleterole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/deleterole","metadata":{"seo":{"title":"Delete an admin user role","description":"Deletes an admin user role."}},"httpPath":"/v3/admin/roles/{role_id}"},{"label":"Retrieve an admin user by session ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/getsessionuser","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/getsessionuser","metadata":{"seo":{"title":"Retrieve an admin user by session ID","description":"Retrieves an admin user by session ID."}},"httpPath":"/v3/admin/sessions/{blaize_admin_session_id}"}]},{"type":"group","label":"Bundle","link":"/zephr-api-reference/zephr-admin-api/bundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle","items":[{"label":"List Bundles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/listbundles","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/listbundles","metadata":{"seo":{"title":"List Bundles","description":"Retrieves a list of bundles wrapped in the element \"results\". Each bundle contains a list of entitlements, meters, credits, and other bundles."}},"httpPath":"/v3/bundles"},{"label":"Create Bundles","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/createbundles","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/createbundles","metadata":{"seo":{"title":"Create Bundles","description":"Creates Bundles."}},"httpPath":"/v3/bundles"},{"label":"Create a Bundle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/createbundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/createbundle","metadata":{"seo":{"title":"Create a Bundle","description":"Creates a Bundle."}},"httpPath":"/v3/bundles/{id}"},{"label":"Retrieve a Bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/getbundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/getbundle","metadata":{"seo":{"title":"Retrieve a Bundle","description":"Retrieves a single bundle. Each bundle contains a list of entitlements, meters, credits, and other bundles."}},"httpPath":"/v3/bundles/{id}"},{"label":"Delete Bundle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/deletebundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/deletebundle","metadata":{"seo":{"title":"Delete Bundle","description":"Deletes a Bundle."}},"httpPath":"/v3/bundles/{id}"}]},{"type":"group","label":"Cache Configurations","link":"/zephr-api-reference/zephr-admin-api/cache-configurations","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations","items":[{"label":"List cache configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/listcacheconfigurations","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/listcacheconfigurations","metadata":{"seo":{"title":"List cache configurations","description":"Retrieves a list of cache configurations wrapped in the element \"results\"."}},"httpPath":"/v3/cache-configurations"},{"label":"Create a cache configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/createcacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/createcacheconfiguration","metadata":{"seo":{"title":"Create a cache configuration","description":"Creates a Cache Configuration."}},"httpPath":"/v3/cache-configurations"},{"label":"Retrieve a cache configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/getcacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/getcacheconfiguration","metadata":{"seo":{"title":"Retrieve a cache configuration","description":"Retrieves a single cache configuration."}},"httpPath":"/v3/cache-configurations/{id}"},{"label":"Delete a cache configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/deletecacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/deletecacheconfiguration","metadata":{"seo":{"title":"Delete a cache configuration","description":"Deletes a cache configuration"}},"httpPath":"/v3/cache-configurations/{id}"},{"label":"Update a cache configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/updatecacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/updatecacheconfiguration","metadata":{"seo":{"title":"Update a cache configuration","description":"Updates a cache configuration."}},"httpPath":"/v3/cache-configurations/{id}"}]},{"type":"group","label":"Cache Management","link":"/zephr-api-reference/zephr-admin-api/cache-management","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management","items":[{"label":"Evict cached origin requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-management/evictorigin","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management/evictorigin","metadata":{"seo":{"title":"Evict cached origin requests","description":"Evicts all cached origin requests with path matching the supplied regular expression."}},"httpPath":"/v3/cache-management/evict-origin"},{"label":"Evict cached origin requests (V4)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginsitev4","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginsitev4","metadata":{"seo":{"title":"Evict cached origin requests (V4)","description":"Evicts all cached origin requests with path matching the supplied regular expression."}},"httpPath":"/v4/cache-management/evict-origin"},{"label":"Evict cached origin requests for a given site in V4","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginv4","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginv4","metadata":{"seo":{"title":"Evict cached origin requests for a given site in V4","description":"Evicts all of the origin cache matching the path pattern provided in the request body for a given site, evicts all paths if .* is provided as path pattern."}},"httpPath":"/v4/cache-management/evict-origin/{site}"}]},{"type":"group","label":"Company","link":"/zephr-api-reference/zephr-admin-api/company","routeSlug":"/zephr-api-reference/zephr-admin-api/company","items":[{"label":"List companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/listcompanies","routeSlug":"/zephr-api-reference/zephr-admin-api/company/listcompanies","metadata":{"seo":{"title":"List companies","description":"Retrieves a list of companies wrapped in the element \"results\"."}},"httpPath":"/v3/companies"},{"label":"Create a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/createcompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/createcompany","metadata":{"seo":{"title":"Create a company","description":"Creates a company."}},"httpPath":"/v3/companies"},{"label":"Retrieve a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/getcompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/getcompany","metadata":{"seo":{"title":"Retrieve a company","description":"Retrieves a single company."}},"httpPath":"/v3/companies/{id}"},{"label":"Delete a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/deletecompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/deletecompany","metadata":{"seo":{"title":"Delete a company","description":"Deletes a company."}},"httpPath":"/v3/companies/{id}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/updatecompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/updatecompany","metadata":{"seo":{"title":"Update a company","description":"Updates a company."}},"httpPath":"/v3/companies/{id}"},{"label":"Create a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies/post","routeSlug":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies/post","metadata":{"seo":{"title":"Create a company","description":"Creates a company with the details specified in the request body"}},"httpPath":"/v4/companies"},{"label":"Retrieve a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies~1{companyid}/get","routeSlug":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies~1{companyid}/get","metadata":{"seo":{"title":"Retrieve a company","description":"Retrieves company information for a company specified by the provided identifier (companyId)"}},"httpPath":"/v4/companies/{companyId}"}]},{"type":"group","label":"Component Library","link":"/zephr-api-reference/zephr-admin-api/component-library","routeSlug":"/zephr-api-reference/zephr-admin-api/component-library","items":[{"label":"Generate Thumbnail Upload URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/component-library/generatethumbnailuploadurl","routeSlug":"/zephr-api-reference/zephr-admin-api/component-library/generatethumbnailuploadurl","metadata":{"seo":{"title":"Generate Thumbnail Upload URL","description":"Generates a pre-signed URL for securely uploading a thumbnail image. The link expires after 10 minutes."}},"httpPath":"/v4/thumbnails/upload-url"}]},{"type":"group","label":"Configuration","link":"/zephr-api-reference/zephr-admin-api/configuration","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration","items":[{"label":"Save the tenant configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/saveconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/saveconfiguration","metadata":{"seo":{"title":"Save the tenant configuration","description":"Creates or updates the tenant configuration."}},"httpPath":"/v3/configuration"},{"label":"Retrieve the tenant configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/getconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/getconfiguration","metadata":{"seo":{"title":"Retrieve the tenant configuration","description":"Retrieves the tenant configuration."}},"httpPath":"/v3/configuration"},{"label":"Update blacklisted email domains","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/updateblacklistedemaildomains","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/updateblacklistedemaildomains","metadata":{"seo":{"title":"Update blacklisted email domains","description":"Replaces the full list of blacklisted email domains for the tenant. Existing blacklisted email domains are removed and replaced with the values provided in the request body."}},"httpPath":"/v4/blacklisted-email-domains"},{"label":"List blacklisted email domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/listblacklistedemaildomains","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/listblacklistedemaildomains","metadata":{"seo":{"title":"List blacklisted email domains","description":"Fetches the list of blacklisted email addresses for the tenant."}},"httpPath":"/v4/blacklisted-email-domains"},{"label":"Install a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/installtenant","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/installtenant","metadata":{"seo":{"title":"Install a tenant","description":"Installs a tenant in Blaize."}},"httpPath":"/v3/initialize"},{"label":"Create a cert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/createcert","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/createcert","metadata":{"seo":{"title":"Create a cert","description":"Creates a cert."}},"httpPath":"/v3/certs"},{"label":"Delete a cert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/deletecert","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/deletecert","metadata":{"seo":{"title":"Delete a cert","description":"Deletes a cert."}},"httpPath":"/v3/certs"}]},{"type":"group","label":"Credit","link":"/zephr-api-reference/zephr-admin-api/credit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit","items":[{"label":"List credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/credits","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/credits","metadata":{"seo":{"title":"List credits","description":"Retrieves a list of credits wrapped in the element \"results\"."}},"httpPath":"/v3/credits"},{"label":"Create Credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/createcredits","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/createcredits","metadata":{"seo":{"title":"Create Credit","description":"Create an Credit"}},"httpPath":"/v3/credits"},{"label":"Create a credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/createcredit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/createcredit","metadata":{"seo":{"title":"Create a credit","description":"Creates a credit."}},"httpPath":"/v3/credits/{id}"},{"label":"Retrieve a credit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/getcredit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/getcredit","metadata":{"seo":{"title":"Retrieve a credit","description":"Retrieves a single credit."}},"httpPath":"/v3/credits/{id}"},{"label":"Delete a credit","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/deletecredit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/deletecredit","metadata":{"seo":{"title":"Delete a credit","description":"Deletes a credit."}},"httpPath":"/v3/credits/{id}"}]},{"type":"group","label":"Decision Engine","link":"/zephr-api-reference/zephr-admin-api/decision-engine","routeSlug":"/zephr-api-reference/zephr-admin-api/decision-engine","items":[{"label":"Invoke the decision engine","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/decision-engine/invokedecisionengine","routeSlug":"/zephr-api-reference/zephr-admin-api/decision-engine/invokedecisionengine","metadata":{"seo":{"title":"Invoke the decision engine","description":"Invokes the decision engine. The Blaize Decision Engine can be invoked via the Admin API to calculate an HTTP Response based upon Request-Level Rules created in the Admin Console. This functionality is build into the Blaize Dynamic CDN but the API variant is useful for CMS or edge side integrations."}},"httpPath":"/v3/decision-engine"}]},{"type":"group","label":"Email Templates","link":"/zephr-api-reference/zephr-admin-api/email-templates","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates","items":[{"label":"List email templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/listemailtemplates","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/listemailtemplates","metadata":{"seo":{"title":"List email templates","description":"Retrieves a list of email templates."}},"httpPath":"/v4/email-templates"},{"label":"Retrieve an email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/getemailtemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/getemailtemplate","metadata":{"seo":{"title":"Retrieve an email template","description":"Retrieves a single email template."}},"httpPath":"/v4/email-templates/{slug}"},{"label":"Delete an email template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/deleteemailtemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/deleteemailtemplate","metadata":{"seo":{"title":"Delete an email template","description":"Deletes an email template."}},"httpPath":"/v4/email-templates/{slug}"},{"label":"Save an email template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/saveemailtemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/saveemailtemplate","metadata":{"seo":{"title":"Save an email template","description":"Saves an email template."}},"httpPath":"/v4/email-templates/{slug}"}]},{"type":"group","label":"Entitlement","link":"/zephr-api-reference/zephr-admin-api/entitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement","items":[{"label":"List entitlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/listentitlements","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/listentitlements","metadata":{"seo":{"title":"List entitlements","description":"Retrieves a list of entitlements wrapped in the element \"results\"."}},"httpPath":"/v3/entitlements"},{"label":"Create entitlements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlements","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlements","metadata":{"seo":{"title":"Create entitlements","description":"Creates entitlements."}},"httpPath":"/v3/entitlements"},{"label":"Create an entitlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlement","metadata":{"seo":{"title":"Create an entitlement","description":"Creates an entitlement."}},"httpPath":"/v3/entitlements/{id}"},{"label":"Retrieve an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/getentitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/getentitlement","metadata":{"seo":{"title":"Retrieve an entitlement","description":"Retrieves a single entitlement."}},"httpPath":"/v3/entitlements/{id}"},{"label":"Delete an entitlement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/deleteentitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/deleteentitlement","metadata":{"seo":{"title":"Delete an entitlement","description":"Deletes an entitlement."}},"httpPath":"/v3/entitlements/{id}"}]},{"type":"group","label":"Feature Rules","link":"/zephr-api-reference/zephr-admin-api/feature-rules","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules","items":[{"label":"List feature rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/listfeaturerules","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/listfeaturerules","metadata":{"seo":{"title":"List feature rules","description":"Retrieves a list of feature rules."}},"httpPath":"/v3/feature-rules"},{"label":"Delete a feature rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeaturerule","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeaturerule","metadata":{"seo":{"title":"Delete a feature rule","description":"Deletes a feature rule."}},"httpPath":"/v3/feature-rules/{featureRuleId}"},{"label":"List the versions of a feature rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversions","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversions","metadata":{"seo":{"title":"List the versions of a feature rule","description":"Retrieves a lists of all the versions for a single feature rule."}},"httpPath":"/v3/feature-rules/{featureRuleId}/versions"},{"label":"Create a feature rule version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/createfeaturerule","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/createfeaturerule","metadata":{"seo":{"title":"Create a feature rule version","description":"Creates a feature rule version."}},"httpPath":"/v3/feature-rules/{featureRuleId}/versions"},{"label":"Retrieve a feature rule version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversion","metadata":{"seo":{"title":"Retrieve a feature rule version","description":"Retrieves a version for a single feature rule."}},"httpPath":"/v3/feature-rules/{featureRuleId}/versions/{versionId}"},{"label":"Delete a feature rule version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeatureruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeatureruleversion","metadata":{"seo":{"title":"Delete a feature rule version","description":"Deletes a single version of a feature rule."}},"httpPath":"/v3/feature-rules/{featureRuleId}/versions/{versionId}"},{"label":"Save feature rule version tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/savefeaturerule","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/savefeaturerule","metadata":{"seo":{"title":"Save feature rule version tags","description":"Saves the feature rule version tags."}},"httpPath":"/v3/feature-rules/{featureRuleId}/versions/{versionId}/tags"}]},{"type":"group","label":"Form","link":"/zephr-api-reference/zephr-admin-api/form","routeSlug":"/zephr-api-reference/zephr-admin-api/form","items":[{"label":"List forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/listforms","routeSlug":"/zephr-api-reference/zephr-admin-api/form/listforms","metadata":{"seo":{"title":"List forms","description":"Retrieves a list of forms wrapped in the element \"results\"."}},"httpPath":"/v3/forms"},{"label":"Retrieve Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/getform","routeSlug":"/zephr-api-reference/zephr-admin-api/form/getform","metadata":{"seo":{"title":"Retrieve Form","description":"Retrieves a single form."}},"httpPath":"/v3/forms/{slug}"},{"label":"Delete a form","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/deleteform","routeSlug":"/zephr-api-reference/zephr-admin-api/form/deleteform","metadata":{"seo":{"title":"Delete a form","description":"Deletes a form."}},"httpPath":"/v3/forms/{slug}"},{"label":"Save a form","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/saveform","routeSlug":"/zephr-api-reference/zephr-admin-api/form/saveform","metadata":{"seo":{"title":"Save a form","description":"Saves a form."}},"httpPath":"/v3/forms/{slug}"}]},{"type":"group","label":"Gifts","link":"/zephr-api-reference/zephr-admin-api/gifts","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts","items":[{"label":"List all the unclaimed gifts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/gifts/listallunclaimedgifts","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts/listallunclaimedgifts","metadata":{"seo":{"title":"List all the unclaimed gifts","description":"Lists all the unclaimed gifts."}},"httpPath":"/v3/gift"},{"label":"Create a gift","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/gifts/creategift","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts/creategift","metadata":{"seo":{"title":"Create a gift","description":"Creates a gift."}},"httpPath":"/v3/gift"},{"label":"Delete a gift","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/gifts/deletegift","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts/deletegift","metadata":{"seo":{"title":"Delete a gift","description":"Deletes a gift."}},"httpPath":"/v3/gift/{giftId}"}]},{"type":"group","label":"Grants","link":"/zephr-api-reference/zephr-admin-api/grants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants","items":[{"label":"List user grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/listusergrants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/listusergrants","metadata":{"seo":{"title":"List user grants","description":"Retrieves a list of user grants."}},"httpPath":"/v3/users/{userId}/grants"},{"label":"Create a grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/creategrants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/creategrants","metadata":{"seo":{"title":"Create a grant","description":"Creates a user grant."}},"httpPath":"/v3/users/{userId}/grants"},{"label":"Retrieve a grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/getaccountgrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/getaccountgrant","metadata":{"seo":{"title":"Retrieve a grant","description":"Retrieves a single grant."}},"httpPath":"/v3/users/{userId}/grants/{grantId}"},{"label":"Delete a grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/deleteusergrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/deleteusergrant","metadata":{"seo":{"title":"Delete a grant","description":"Deletes a grant specified by the grantId. This is for a user that is specified by the userId"}},"httpPath":"/v3/users/{userId}/grants/{grantId}"},{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/creategrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/creategrant","metadata":{"seo":{"title":"Create an account grant","description":"Creates an account grant."}},"httpPath":"/v3/users/{userId}/grants/{grantId}"},{"label":"Retrieve a user access model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/retrieveuseraccessmodel","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/retrieveuseraccessmodel","metadata":{"seo":{"title":"Retrieve a user access model","description":"Retrieves a user access model."}},"httpPath":"/v3/users/{userId}/accessModel"},{"label":"List account grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/listaccountgrants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/listaccountgrants","metadata":{"seo":{"title":"List account grants","description":"Retrieves a list of account grants."}},"httpPath":"/v3/accounts/{accountId}/grants"},{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrant","metadata":{"seo":{"title":"Create an account grant","description":"Creates an account grant."}},"httpPath":"/v3/accounts/{accountId}/grants"},{"label":"Retrieve an account grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/getusergrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/getusergrant","metadata":{"seo":{"title":"Retrieve an account grant","description":"Retrieves a single account grant information, if the supplied accountId and grantId match"}},"httpPath":"/v3/accounts/{accountId}/grants/{grantId}"},{"label":"Delete an account grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrantbyid","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrantbyid","metadata":{"seo":{"title":"Delete an account grant","description":"Deletes an account grant specified by the grantId. This is for a user that is specified by the accountId."}},"httpPath":"/v3/accounts/{accountId}/grants/{grantId}"},{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrantv4","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrantv4","metadata":{"seo":{"title":"Create an account grant","description":"Creates an account grant. This is for an account that is specified by the accountId"}},"httpPath":"/v4/accounts/{accountId}/grants"},{"label":"Delete an account grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrant","metadata":{"seo":{"title":"Delete an account grant","description":"Deletes an account grant specified by the grantId. This is for a user that is specified by the accountId."}},"httpPath":"/v4/accounts/{accountId}/grants/{grantId}"}]},{"type":"group","label":"Meter","link":"/zephr-api-reference/zephr-admin-api/meter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter","items":[{"label":"List meters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/listmeters","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/listmeters","metadata":{"seo":{"title":"List meters","description":"Retrieves a list of meters wrapped in the element \"results\"."}},"httpPath":"/v3/meters"},{"label":"Create a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/createmeter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/createmeter","metadata":{"seo":{"title":"Create a meter","description":"Creates or updates a meter for specified id."}},"httpPath":"/v3/meters/{id}"},{"label":"Retrieve a meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/getmeter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/getmeter","metadata":{"seo":{"title":"Retrieve a meter","description":"Retrieves a single meter with specified id."}},"httpPath":"/v3/meters/{id}"},{"label":"Delete a meter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/deletemeter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/deletemeter","metadata":{"seo":{"title":"Delete a meter","description":"Deletes a meter if the meter with id exists."}},"httpPath":"/v3/meters/{id}"}]},{"type":"group","label":"Products","link":"/zephr-api-reference/zephr-admin-api/products","routeSlug":"/zephr-api-reference/zephr-admin-api/products","items":[{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/listproducts","routeSlug":"/zephr-api-reference/zephr-admin-api/products/listproducts","metadata":{"seo":{"title":"List products","description":"Retrieves all configured products."}},"httpPath":"/v3/products"},{"label":"Save a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/saveproduct","routeSlug":"/zephr-api-reference/zephr-admin-api/products/saveproduct","metadata":{"seo":{"title":"Save a product","description":"This endpoint saves a product with the given details specified in the body of the request. The product ID is randomyly generated and provided as part of the URI path parameter response returned on success."}},"httpPath":"/v3/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/getproduct","routeSlug":"/zephr-api-reference/zephr-admin-api/products/getproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves a single product. The product is identified by the id path parameter."}},"httpPath":"/v3/products/{id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/deleteproduct","routeSlug":"/zephr-api-reference/zephr-admin-api/products/deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Deletes a product. The product is identified by the id path parameter."}},"httpPath":"/v3/products/{id}"},{"label":"Save a product with the given ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/saveproducts","routeSlug":"/zephr-api-reference/zephr-admin-api/products/saveproducts","metadata":{"seo":{"title":"Save a product with the given ID","description":"This endpoint both saves and updates a product. The product is identified by the id path parameter. If the product ID does not exist, then a new product with the corresponding ID will be created. Otherwise, the existing product will be modified."}},"httpPath":"/v3/products/{id}"}]},{"type":"group","label":"Request Rules","link":"/zephr-api-reference/zephr-admin-api/request-rules","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules","items":[{"label":"List request rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/listrequestrules","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/listrequestrules","metadata":{"seo":{"title":"List request rules","description":"Retrieves a list of request rules wrapped in the element \"results\"."}},"httpPath":"/v3/request-rules"},{"label":"Save a request rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/saverequestrule","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/saverequestrule","metadata":{"seo":{"title":"Save a request rule","description":"Saves a request rule."}},"httpPath":"/v3/request-rules"},{"label":"Delete a request rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestrule","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestrule","metadata":{"seo":{"title":"Delete a request rule","description":"Deletes a request rule."}},"httpPath":"/v3/request-rules/{id}"},{"label":"Retrieve a particular version of a request rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/getrequestruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/getrequestruleversion","metadata":{"seo":{"title":"Retrieve a particular version of a request rule","description":"Retrieves a request rule version."}},"httpPath":"/v3/request-rules/{id}/versions/{versionId}"},{"label":"Delete a request rule version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestruleversion","metadata":{"seo":{"title":"Delete a request rule version","description":"Deletes a request rule version."}},"httpPath":"/v3/request-rules/{id}/versions/{versionId}"}]},{"type":"group","label":"Session","link":"/zephr-api-reference/zephr-admin-api/session","routeSlug":"/zephr-api-reference/zephr-admin-api/session","items":[{"label":"Create a session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/session/createnewsession","routeSlug":"/zephr-api-reference/zephr-admin-api/session/createnewsession","metadata":{"seo":{"title":"Create a session","description":"Creates a new session."}},"httpPath":"/v3/sessions"},{"label":"Retrieve a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/session/getsession","routeSlug":"/zephr-api-reference/zephr-admin-api/session/getsession","metadata":{"seo":{"title":"Retrieve a session","description":"Looks up a session."}},"httpPath":"/v3/sessions/{id}"}]},{"type":"group","label":"Static Items","link":"/zephr-api-reference/zephr-admin-api/static-items","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items","items":[{"label":"List static items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/liststaticitems","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/liststaticitems","metadata":{"seo":{"title":"List static items","description":"Retrieves a list of static item ids wrapped in the element \"results\"."}},"httpPath":"/v3/static"},{"label":"Retrieve a static item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/getitem","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/getitem","metadata":{"seo":{"title":"Retrieve a static item","description":"Retrieves a static item."}},"httpPath":"/v3/static/{id}"},{"label":"Delete a static item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/delete_item","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/delete_item","metadata":{"seo":{"title":"Delete a static item","description":"Deletes a static item."}},"httpPath":"/v3/static/{id}"},{"label":"Save a static item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/saveitem","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/saveitem","metadata":{"seo":{"title":"Save a static item","description":"Saves a static item."}},"httpPath":"/v3/static/{id}"}]},{"type":"group","label":"Third Party Authentication","link":"/zephr-api-reference/zephr-admin-api/third-party-authentication","routeSlug":"/zephr-api-reference/zephr-admin-api/third-party-authentication","items":[{"label":"Token refresh or exchange","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/third-party-authentication/refreshorexchangetoken","routeSlug":"/zephr-api-reference/zephr-admin-api/third-party-authentication/refreshorexchangetoken","metadata":{"seo":{"title":"Token refresh or exchange","description":"Exchanges the OAuth2 authorization code for an access token, or refreshes an existing access token using a refresh token."}},"httpPath":"/zephr/oauth2/token"}]},{"type":"group","label":"User Export","link":"/zephr-api-reference/zephr-admin-api/user-export","routeSlug":"/zephr-api-reference/zephr-admin-api/user-export","items":[{"label":"Export users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-export/exportusers","routeSlug":"/zephr-api-reference/zephr-admin-api/user-export/exportusers","metadata":{"seo":{"title":"Export users","description":"Export users who match the provided parameters."}},"httpPath":"/v3/user-export"},{"label":"Export users and user events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-export/exportuserandeventscsv","routeSlug":"/zephr-api-reference/zephr-admin-api/user-export/exportuserandeventscsv","metadata":{"seo":{"title":"Export users and user events","description":"Downloads all subscribers and subscriber events data in csv format."}},"httpPath":"/v4/user-export"}]},{"type":"group","label":"User Schema","link":"/zephr-api-reference/zephr-admin-api/user-schema","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema","items":[{"label":"Retrieve a user schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/retrieveuserschema","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/retrieveuserschema","metadata":{"seo":{"title":"Retrieve a user schema","description":"Retrieves a user Schema."}},"httpPath":"/v3/schema/users"},{"label":"Retrieve a schema slug","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/getschemaslug","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/getschemaslug","metadata":{"seo":{"title":"Retrieve a schema slug","description":"Retrieves a schema slug."}},"httpPath":"/v3/schema/users/{slug}"},{"label":"Delete a schema slug","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/deleteschemaslug","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/deleteschemaslug","metadata":{"seo":{"title":"Delete a schema slug","description":"Deletes a schema slug."}},"httpPath":"/v3/schema/users/{slug}"},{"label":"Save a schema slug","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/saveschemaslug","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/saveschemaslug","metadata":{"seo":{"title":"Save a schema slug","description":"Saves a schema slug."}},"httpPath":"/v3/schema/users/{slug}"}]},{"type":"group","label":"Users","link":"/zephr-api-reference/zephr-admin-api/users","routeSlug":"/zephr-api-reference/zephr-admin-api/users","items":[{"label":"Delete an end user by primary ID or foreign key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteuserbyprimaryorforeignkey","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteuserbyprimaryorforeignkey","metadata":{"seo":{"title":"Delete an end user by primary ID or foreign key","description":"Deletes an end user and associated data from the system."}},"httpPath":"/zephr/integration/users/v1/users"},{"label":"Insert a foreign key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/upsertforeignkey","routeSlug":"/zephr-api-reference/zephr-admin-api/users/upsertforeignkey","metadata":{"seo":{"title":"Insert a foreign key","description":"Adds a foreign key mapping to a user. This operation does not update or overwrite an existing mapping. A user can have multiple foreign keys for the same system. To replace an existing mapping, first delete the current mapping using the Delete a foreign key operation, then call this operation with the new foreign key value."}},"httpPath":"/v3/users/{userId}/foreign-key/update/{key}"},{"label":"Delete a foreign key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteforeignkey","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteforeignkey","metadata":{"seo":{"title":"Delete a foreign key","description":"Deletes the provided foreign key, if the supplied userId, system, and key match."}},"httpPath":"/v4/users/{userId}/foreign-key/{key}/{system}"},{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusers","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusers","metadata":{"seo":{"title":"List users","description":"Retrieves a list of users wrapped in the element \"results\"."}},"httpPath":"/v3/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/createuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/createuser","metadata":{"seo":{"title":"Create a user","description":"Creates a new user."}},"httpPath":"/v3/users"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/getuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/getuser","metadata":{"seo":{"title":"Retrieve a user","description":"Retrieves a user."}},"httpPath":"/v3/users/{user_id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteuser","metadata":{"seo":{"title":"Delete a user","description":"Deletes a user."}},"httpPath":"/v3/users/{user_id}"},{"label":"Update all user attributes","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/replaceuserattributes","routeSlug":"/zephr-api-reference/zephr-admin-api/users/replaceuserattributes","metadata":{"seo":{"title":"Update all user attributes","description":"Replaces a user's attributes. This will replace any existing attributes for the user with the attributes in the payload. To leave existing attributes in place, use PATCH."}},"httpPath":"/v3/users/{user_id}/attributes"},{"label":"Update user attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/updateuserattribute","routeSlug":"/zephr-api-reference/zephr-admin-api/users/updateuserattribute","metadata":{"seo":{"title":"Update user attributes","description":"Updates a user's attributes. Any of the user's existing attributes not specified in the payload will be left in-place."}},"httpPath":"/v3/users/{user_id}/attributes"},{"label":"Retrieve Extended User Profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","routeSlug":"/zephr-api-reference/zephr-admin-api/users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","metadata":{"seo":{"title":"Retrieve Extended User Profiles","description":"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."}},"httpPath":"/v3/users/{user_id}/profile/{app_id}"},{"label":"Update users in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/updatebulkusers","routeSlug":"/zephr-api-reference/zephr-admin-api/users/updatebulkusers","metadata":{"seo":{"title":"Update users in bulk","description":"Updates user's attributfoes or delete users on a bulk basis."}},"httpPath":"/v4/user-updates"},{"label":"List all bulk user update jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listbulkuserupdatejobs","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listbulkuserupdatejobs","metadata":{"seo":{"title":"List all bulk user update jobs","description":"Lists all bulk user update jobs."}},"httpPath":"/v4/user-updates"},{"label":"Retrieves a bulk user update job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/retrievebulkuserupdatejob","routeSlug":"/zephr-api-reference/zephr-admin-api/users/retrievebulkuserupdatejob","metadata":{"seo":{"title":"Retrieves a bulk user update job","description":"Retrieves the status of a bulk user update job."}},"httpPath":"/v4/user-updates/{job_id}"},{"label":"Create a user segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/createusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/createusersegment","metadata":{"seo":{"title":"Create a user segment","description":"Creates a new User Segment."}},"httpPath":"/v4/users/segments"},{"label":"List user segments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusersegment","metadata":{"seo":{"title":"List user segments","description":"Lists all user segments available for users."}},"httpPath":"/v4/users/segments"},{"label":"Retrieve a user segment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/getusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/getusersegment","metadata":{"seo":{"title":"Retrieve a user segment","description":"Retrieves a user segment."}},"httpPath":"/v4/users/segments/{segmentId}"},{"label":"Delete a user segment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteusersegment","metadata":{"seo":{"title":"Delete a user segment","description":"Deletes a user segment by ID."}},"httpPath":"/v4/users/segments/{segmentId}"},{"label":"List user segments for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusersegmentsforuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusersegmentsforuser","metadata":{"seo":{"title":"List user segments for a user","description":"Lists all user segments for a given userId."}},"httpPath":"/v4/users/{userId}/segments"},{"label":"Start an email address update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/startemailaddressupdate","routeSlug":"/zephr-api-reference/zephr-admin-api/users/startemailaddressupdate","metadata":{"seo":{"title":"Start an email address update","description":"Starts an email address update. If the Require Email Verification configuration flag is set, to update a user's email address, first they need to verify their new address. If the Email Change Override feature flag is enabled, the an email with a link to verify the address will be sent to the new address. Otherwise the email will be sent to the old address. If the Require Email Verification configuration flag is not set, this endpoint sets the new email address immediately. If the user has a username and the provided email address is blank, the email address is deleted. If the user does not have a username and the provided email address is blank, a 400 is returned."}},"httpPath":"/v3/users/{user_id}/update-email"},{"label":"Start a password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/startpasswordreset","routeSlug":"/zephr-api-reference/zephr-admin-api/users/startpasswordreset","metadata":{"seo":{"title":"Start a password reset","description":"Starts a password reset."}},"httpPath":"/v4/users/reset"},{"label":"Start a passwordless authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/startpasswordlessauthentication","routeSlug":"/zephr-api-reference/zephr-admin-api/users/startpasswordlessauthentication","metadata":{"seo":{"title":"Start a passwordless authentication","description":"Starts a passwordless authentication."}},"httpPath":"/v3/users/token-exchange"},{"label":"List user sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusersessions","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusersessions","metadata":{"seo":{"title":"List user sessions","description":"Retrieves a list of the user's sessions."}},"httpPath":"/v3/users/{user_id}/sessions"},{"label":"List user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listuseraccounts","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listuseraccounts","metadata":{"seo":{"title":"List user accounts","description":"Retrieves a list of the user's accounts."}},"httpPath":"/v3/users/{user_id}/accounts"},{"label":"Refresh a access model","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/refreshaccessmodel","routeSlug":"/zephr-api-reference/zephr-admin-api/users/refreshaccessmodel","metadata":{"seo":{"title":"Refresh a access model","description":"Refreshes the user's access model."}},"httpPath":"/v3/users/{user_id}/authorization/refresh"},{"label":"Reset a legacy password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/resetlegacypassword","routeSlug":"/zephr-api-reference/zephr-admin-api/users/resetlegacypassword","metadata":{"seo":{"title":"Reset a legacy password","description":"Sets the current password to an empty string, also sets the legacy password to the provided string."}},"httpPath":"/v3/users/{user_Id}/legacyPassword"}]},{"type":"group","label":"V4 Session","link":"/zephr-api-reference/zephr-admin-api/v4-session","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session","items":[{"label":"Create a new session under a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/createnewsessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/createnewsessionundergivensite","metadata":{"seo":{"title":"Create a new session under a given site","description":"Creates a new session under a given site."}},"httpPath":"/v4/sessions/{site}"},{"label":"Look up a session under a given site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/lookupsessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/lookupsessionundergivensite","metadata":{"seo":{"title":"Look up a session under a given site","description":"This endpoint allows you to access specific session details for a particular site. By providing the unique identifiers for the site and the session, you can retrieve detailed information about that session. This information can include the session's start time, end time, current status, and any associated user data. The exact content of the response will depend on the specific session and site identifiers provided in the request."}},"httpPath":"/v4/sessions/{site}/{sessionId}"},{"label":"Delete a session under a given site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/deletesessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/deletesessionundergivensite","metadata":{"seo":{"title":"Delete a session under a given site","description":"This endpoint is used to delete a specific session for a given site. You need to provide the unique identifiers for the site and the session. This operation is useful when you want to manually end a session before it naturally expires."}},"httpPath":"/v4/sessions/{site}/{sessionId}"},{"label":"Create an anonymous session under a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/createanonymoussessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/createanonymoussessionundergivensite","metadata":{"seo":{"title":"Create an anonymous session under a given site","description":"Creates an anonymous session under a given site."}},"httpPath":"/v4/anonymous-sessions/{site}"}]},{"type":"group","label":"Webhook","link":"/zephr-api-reference/zephr-admin-api/webhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/listwebhooks","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"Retrieves a list of webhooks wrapped in the element \"results\"."}},"httpPath":"/v3/webhooks"},{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/createwebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Creates a Webhook."}},"httpPath":"/v3/webhooks"},{"label":"Retrieve a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/getwebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/getwebhook","metadata":{"seo":{"title":"Retrieve a webhook","description":"Retrieves a webhook."}},"httpPath":"/v3/webhooks/{id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/deletewebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Deletes a webhook."}},"httpPath":"/v3/webhooks/{id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/updatewebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Updates a webhook."}},"httpPath":"/v3/webhooks/{id}"}]},{"type":"group","label":"Account","link":"/zephr-api-reference/zephr-admin-api/account","routeSlug":"/zephr-api-reference/zephr-admin-api/account","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/listaccounts","routeSlug":"/zephr-api-reference/zephr-admin-api/account/listaccounts","metadata":{"seo":{"title":"List accounts","description":"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)."}},"httpPath":"/v3/accounts"},{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/createaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/createaccount","metadata":{"seo":{"title":"Create an account","description":"Creates an account."}},"httpPath":"/v3/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/getaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/getaccount","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieves an account."}},"httpPath":"/v3/accounts/{id}"},{"label":"Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/deleteaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/deleteaccount","metadata":{"seo":{"title":"Delete an account","description":"Deletes an account."}},"httpPath":"/v3/accounts/{id}"},{"label":"Update an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/updateaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/updateaccount","metadata":{"seo":{"title":"Update an account","description":"Updates an account."}},"httpPath":"/v3/accounts/{id}"},{"label":"Retrieve an account for V4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/getaccountv4","routeSlug":"/zephr-api-reference/zephr-admin-api/account/getaccountv4","metadata":{"seo":{"title":"Retrieve an account for V4","description":"Retrieves an V4 account."}},"httpPath":"/v4/accounts/{account_id}"},{"label":"List accounts for v4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/listaccountsv4","routeSlug":"/zephr-api-reference/zephr-admin-api/account/listaccountsv4","metadata":{"seo":{"title":"List accounts for v4","description":"Retrieves a list of accounts for V4."}},"httpPath":"/v4/accounts"}]},{"type":"group","label":"Health Check","link":"/zephr-api-reference/zephr-admin-api/health-check","routeSlug":"/zephr-api-reference/zephr-admin-api/health-check","items":[{"label":"Check availability of the origin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/health-check/paths/~1v3~1healthchecks~1origin/get","routeSlug":"/zephr-api-reference/zephr-admin-api/health-check/paths/~1v3~1healthchecks~1origin/get","metadata":{"seo":{"title":"Check availability of the origin","description":"Sends a request to the origin site to verify availability."}},"httpPath":"/v3/healthchecks/origin"}]},{"type":"group","label":"System Resources","link":"/zephr-api-reference/zephr-admin-api/system-resources","routeSlug":"/zephr-api-reference/zephr-admin-api/system-resources","items":[{"label":"Update system resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/system-resources/paths/~1v4~1resources~1{resourceid}~1content/put","routeSlug":"/zephr-api-reference/zephr-admin-api/system-resources/paths/~1v4~1resources~1{resourceid}~1content/put","metadata":{"seo":{"title":"Update system resource","description":"Update system resource by provided resourceId"}},"httpPath":"/v4/resources/{resourceId}/content"}]},{"type":"group","label":"External Templates","link":"/zephr-api-reference/zephr-admin-api/external-template","routeSlug":"/zephr-api-reference/zephr-admin-api/external-template","items":[]},{"type":"group","label":"Accounts","link":"/zephr-api-reference/zephr-admin-api/accounts","routeSlug":"/zephr-api-reference/zephr-admin-api/accounts","items":[{"label":"Post an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/accounts/postaccountbulking","routeSlug":"/zephr-api-reference/zephr-admin-api/accounts/postaccountbulking","metadata":{"seo":{"title":"Post an account grant","description":"Adding account users to company account by email domain."}},"httpPath":"/v4/accounts/{accountId}/users"}]},{"type":"group","label":"Request Rules Version","link":"/zephr-api-reference/zephr-admin-api/request-rules-version","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules-version","items":[{"label":"Create a request rule version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules-version/createrequestruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules-version/createrequestruleversion","metadata":{"seo":{"title":"Create a request rule version","description":"Create a request rule version"}},"httpPath":"/v3/request-rules/{id}/versions"}]},{"label":"Fetch external template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/other/fetchexternaltemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/other/fetchexternaltemplate","metadata":{"seo":{"title":"Fetch external template","description":"Fetch External Template"}},"httpPath":"/zephr/public/template-components/v1/template-components/{templateConfigId}"},{"type":"group","label":"Pages","link":"/zephr-api-reference/zephr-admin-api/pages","routeSlug":"/zephr-api-reference/zephr-admin-api/pages","items":[{"label":"Generates an S3 upload URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/pages/generatepageuploadurl","routeSlug":"/zephr-api-reference/zephr-admin-api/pages/generatepageuploadurl","metadata":{"seo":{"title":"Generates an S3 upload URL","description":"Generates a presigned S3 URL that can be used to upload a logo."}},"httpPath":"/v4/pages/upload-url"}]},{"type":"group","label":"Dynamic Offer Promo code redemption","link":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption","routeSlug":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption","items":[{"label":"Process promo code redemptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption/processpromocoderedemptions","routeSlug":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption/processpromocoderedemptions","metadata":{"seo":{"title":"Process promo code redemptions","description":"Redeem promo codes that are configured from the Zephr console. Responds with a list of redemption results for each promo code."}},"httpPath":"/zephr/integration/promo-codes/v1/redemptions"}]},{"type":"group","label":"Subscription","link":"/zephr-api-reference/zephr-admin-api/subscription","routeSlug":"/zephr-api-reference/zephr-admin-api/subscription","items":[{"label":"Cancel Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/subscription/cancelsubscriptionlegacy","routeSlug":"/zephr-api-reference/zephr-admin-api/subscription/cancelsubscriptionlegacy","metadata":{"seo":{"title":"Cancel Subscription","description":"Cancels a subscription using the legacy method."}},"httpPath":"/blaize/payment/braintree/subscriptions/{externalId}"},{"label":"Update Braintree Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/subscription/orchestrateupdatebraintreesubscription","routeSlug":"/zephr-api-reference/zephr-admin-api/subscription/orchestrateupdatebraintreesubscription","metadata":{"seo":{"title":"Update Braintree Subscription","description":"Updates a Braintree subscription."}},"httpPath":"/blaize/payment/braintree/subscriptions/{externalId}"}]}]}]},{"type":"group","label":"Public API reference","items":[{"type":"group","label":"v5 API","items":[{"type":"link","label":"v5 Public API reference","link":"/zephr-api-reference/zephr-v5-public-openapi","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi"},{"type":"separator","label":"Decisions"},{"type":"group","label":"HTML Rule","link":"/zephr-api-reference/zephr-v5-public-openapi/html-rule","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/html-rule","items":[{"label":"HTML feature transformations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/html-rule/getfeaturetransformations","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/html-rule/getfeaturetransformations","metadata":{"seo":{"title":"HTML feature transformations","description":"Evaluates HTML feature rules configured in the Zephr Console and returns feature transformations for the browser."}},"httpPath":"/zephr/v5/decisions/html"}]},{"type":"group","label":"Redirect Rule","link":"/zephr-api-reference/zephr-v5-public-openapi/redirect-rule","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/redirect-rule","items":[{"label":"Evaluate redirect rules","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/redirect-rule/getdecisionenginerule","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/redirect-rule/getdecisionenginerule","metadata":{"seo":{"title":"Evaluate redirect rules","description":"Evaluates request-level redirect rules configured in the Zephr Console and returns HTTP 200 with the status, body, and headers the client should apply."}},"httpPath":"/zephr/v5/decisions/redirect"}]},{"type":"group","label":"SDK Rule","link":"/zephr-api-reference/zephr-v5-public-openapi/sdk-rule","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/sdk-rule","items":[{"label":"Evaluate SDK feature decisions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/sdk-rule/getfeaturedecisions","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/sdk-rule/getfeaturedecisions","metadata":{"seo":{"title":"Evaluate SDK feature decisions","description":"Evaluates SDK feature rules configured in the Zephr Console and returns a decision for each requested feature."}},"httpPath":"/zephr/v5/decisions/sdk"}]},{"type":"separator","label":"Rule Features"},{"type":"group","label":"Features","link":"/zephr-api-reference/zephr-v5-public-openapi/features","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/features","items":[{"label":"Retrieve the Zephr Feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/features/getfeatures","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/features/getfeatures","metadata":{"seo":{"title":"Retrieve the Zephr Feature","description":"Returns browser features by default. Optionally, filter by type using the ruleType parameter: html, browser, json, or sdk. Defaults to all browser features."}},"httpPath":"/zephr/v5/features"}]},{"type":"separator","label":"Sessions"},{"type":"group","label":"Authenticated","link":"/zephr-api-reference/zephr-v5-public-openapi/authenticated","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/authenticated","items":[{"label":"List all the user sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/authenticated/listsessions","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/authenticated/listsessions","metadata":{"seo":{"title":"List all the user sessions","description":"Returns all active sessions for the currently authenticated user on this site."}},"httpPath":"/zephr/v5/sessions"},{"label":"Delete all other sessions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/authenticated/deletesessions","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/authenticated/deletesessions","metadata":{"seo":{"title":"Delete all other sessions","description":"Sign yourself out of all other devices while keeping your current session active. Use this to secure your account if you suspect unauthorized access."}},"httpPath":"/zephr/v5/sessions"},{"label":"Delete the session by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/authenticated/deletesession","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/authenticated/deletesession","metadata":{"seo":{"title":"Delete the session by ID","description":"Deletes a session by ID. You can only delete your own sessions. Returns an error if the session doesn't exist or belongs to another user."}},"httpPath":"/zephr/v5/sessions/{sessionId}"}]},{"type":"group","label":"UnAuthenticated","link":"/zephr-api-reference/zephr-v5-public-openapi/unauthenticated","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/unauthenticated","items":[{"label":"Create an anonymous session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/unauthenticated/createanonymoussession","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/unauthenticated/createanonymoussession","metadata":{"seo":{"title":"Create an anonymous session","description":"Creates a session for guest visitors. Allows us to track their activity and customize their experience before they log in or sign up."}},"httpPath":"/zephr/v5/sessions/anonymous"}]},{"type":"separator","label":"Web Analytics"},{"type":"group","label":"Conversions","link":"/zephr-api-reference/zephr-v5-public-openapi/conversions","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/conversions","items":[{"label":"Track when a user completes an action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/conversions/recordconversion","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/conversions/recordconversion","metadata":{"seo":{"title":"Track when a user completes an action","description":"Record user milestones and events for tracking and analysis."}},"httpPath":"/zephr/v5/conversions"}]},{"type":"group","label":"Datalayer","link":"/zephr-api-reference/zephr-v5-public-openapi/datalayer","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/datalayer","items":[{"label":"Retrieve the datalayer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/datalayer/getdatalayer","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/datalayer/getdatalayer","metadata":{"seo":{"title":"Retrieve the datalayer","description":"Retrieves session information that we use for analytics and tracking to improve your experience"}},"httpPath":"/zephr/v5/datalayer"}]},{"type":"separator","label":"Authentication"},{"type":"group","label":"Login","link":"/zephr-api-reference/zephr-v5-public-openapi/login","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/login","items":[{"label":"Authenticate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/login/loginuser","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/login/loginuser","metadata":{"seo":{"title":"Authenticate a user","description":"Logs in a user by verifying their identity. Requires either email, username, or access key, plus a password, security code, or single sign-on."}},"httpPath":"/zephr/v5/users/login"}]},{"type":"group","label":"Logout","link":"/zephr-api-reference/zephr-v5-public-openapi/logout","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/logout","items":[{"label":"Terminate user session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/logout/logoutuser","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/logout/logoutuser","metadata":{"seo":{"title":"Terminate user session","description":"Ends your current session. Without SSO enabled, only the current session is removed."}},"httpPath":"/zephr/v5/users/logout"}]},{"type":"group","label":"Passwordless","link":"/zephr-api-reference/zephr-v5-public-openapi/passwordless","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/passwordless","items":[{"label":"Start passwordless authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/passwordless/startpasswordlessauthentication","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/passwordless/startpasswordlessauthentication","metadata":{"seo":{"title":"Start passwordless authentication","description":"Sends a magic-link email so you can sign in without a password."}},"httpPath":"/zephr/v5/users/token-exchange"},{"label":"Complete passwordless authentication","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/passwordless/completepasswordlessauth","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/passwordless/completepasswordlessauth","metadata":{"seo":{"title":"Complete passwordless authentication","description":"Completes passwordless sign-in using the token from the email link."}},"httpPath":"/zephr/v5/users/token-exchange"}]},{"type":"group","label":"Two Factor Authentication","link":"/zephr-api-reference/zephr-v5-public-openapi/2fa","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/2fa","items":[{"label":"Start two-factor email authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/2fa/starttwofactoremailauth","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/2fa/starttwofactoremailauth","metadata":{"seo":{"title":"Start two-factor email authentication","description":"Initiates two-factor authentication by sending a verification code to your registered email address."}},"httpPath":"/zephr/v5/users/two-factor-authentication"},{"label":"Verify OTP code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/2fa/verifyotpcode","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/2fa/verifyotpcode","metadata":{"seo":{"title":"Verify OTP code","description":"Verifies the one-time password code sent by email during two-factor authentication. Required to confirm identity before login or protected actions."}},"httpPath":"/zephr/v5/users/otp-check"}]},{"type":"separator","label":"Social Login"},{"type":"group","label":"Google, Facebook, LinkedIn, Microsoft","link":"/zephr-api-reference/zephr-v5-public-openapi/oauth2","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oauth2","items":[{"type":"link","label":"Choosing a callback endpoint","link":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/choosing-a-callback-endpoint","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/choosing-a-callback-endpoint"},{"type":"link","label":"Flow summary","link":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/flow-summary","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/flow-summary"},{"label":"Start sign-in with your provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/initiatesociallogin","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/initiatesociallogin","metadata":{"seo":{"title":"Start sign-in with your provider","description":"Initiates sign-in with the provider. You'll be redirected to authorize, then returned to complete login."}},"httpPath":"/zephr/v5/oauth/{provider}"},{"label":"Complete sign-in for web","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/handleoauthcallback","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/handleoauthcallback","metadata":{"seo":{"title":"Complete sign-in for web","description":"Processes the provider's authorization response after you approve sign-in. Completes your login and returns a confirmation page in your browser."}},"httpPath":"/zephr/v5/oauth/{provider}/callback"},{"label":"Complete sign-in for mobile apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/handleoauthcallbackwithclienttype","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oauth2/handleoauthcallbackwithclienttype","metadata":{"seo":{"title":"Complete sign-in for mobile apps","description":"For your mobile app. After you authorize, we log you in and send the result back to your app."}},"httpPath":"/zephr/v5/oauth/{provider}/{clientType}/callback"}]},{"type":"group","label":"Twitter","link":"/zephr-api-reference/zephr-v5-public-openapi/twitter","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/twitter","items":[{"type":"link","label":"Flow summary","link":"/zephr-api-reference/zephr-v5-public-openapi/twitter/flow-summary","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/twitter/flow-summary"},{"label":"Start Twitter sign-in","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/twitter/initiatetwitterlogin","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/twitter/initiatetwitterlogin","metadata":{"seo":{"title":"Start Twitter sign-in","description":"Initiates sign-in with Twitter. You'll be redirected to Twitter to authorize, then returned to complete login."}},"httpPath":"/zephr/v5/oauth/twitter"},{"label":"Complete Twitter sign-in for web","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/twitter/handletwittercallback","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/twitter/handletwittercallback","metadata":{"seo":{"title":"Complete Twitter sign-in for web","description":"Processes Twitter's authorization response after you approve sign-in. Completes your login and returns a confirmation page in your browser."}},"httpPath":"/zephr/v5/oauth/twitter/callback"}]},{"type":"group","label":"Apple","link":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in","items":[{"type":"link","label":"Choosing a callback endpoint","link":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/choosing-a-callback-endpoint","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/choosing-a-callback-endpoint"},{"type":"link","label":"Flow summary","link":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/flow-summary","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/flow-summary"},{"label":"Set up Apple Sign-in","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/initiateapplesignin","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/initiateapplesignin","metadata":{"seo":{"title":"Set up Apple Sign-in","description":"Your Step 2 callback URL depends on your app type:"}},"httpPath":"/zephr/v5/oauth/apple"},{"label":"Process Apple Sign-in for web","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/processapplesigninweb","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/processapplesigninweb","metadata":{"seo":{"title":"Process Apple Sign-in for web","description":"Completes Apple Sign In for the web applications. Receives and processes the authentication confirmation from Apple."}},"httpPath":"/zephr/v5/oauth/apple/callback"},{"label":"Complete Apple Sign-In for mobile apps","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/processapplesigninmobile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/apple-sign-in/processapplesigninmobile","metadata":{"seo":{"title":"Complete Apple Sign-In for mobile apps","description":"Processes Apple Sign In authentication for iOS and Android apps. Receives authorization data from Apple's response."}},"httpPath":"/zephr/v5/oauth/apple/{clientType}/callback"}]},{"type":"group","label":"OpenID Connect","link":"/zephr-api-reference/zephr-v5-public-openapi/oidc","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oidc","items":[{"label":"Start OpenID Connect sign-in","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/oidc/initiateoidclogin","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oidc/initiateoidclogin","metadata":{"seo":{"title":"Start OpenID Connect sign-in","description":"Initiates sign-in with your organization's configured identity provider. You'll be redirected to authorize, then returned to complete login."}},"httpPath":"/zephr/v5/oauth/oidc"},{"label":"Complete OpenID Connect sign-in for mobile apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/oidc/handleoidccallback","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/oidc/handleoidccallback","metadata":{"seo":{"title":"Complete OpenID Connect sign-in for mobile apps","description":"Completes OpenID Connect sign-in after the identity provider redirects back."}},"httpPath":"/zephr/v5/oauth/oidc/{clientType}/callback"}]},{"type":"separator","label":"Credentials"},{"type":"group","label":"Password Change","link":"/zephr-api-reference/zephr-v5-public-openapi/password-change","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/password-change","items":[{"label":"Initiate password change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/password-change/startpasswordchange","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/password-change/startpasswordchange","metadata":{"seo":{"title":"Initiate password change","description":"Initiates password change by validating your current password and sending a security code to your email. Requires login."}},"httpPath":"/zephr/v5/users/change-password"},{"label":"Complete password change","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/password-change/completepasswordchange","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/password-change/completepasswordchange","metadata":{"seo":{"title":"Complete password change","description":"Completes the password change flow by verifying the one-time code emailed after starting a password change, and applying the new password. Requires an authenticated session."}},"httpPath":"/zephr/v5/users/change-password/{otp}"}]},{"type":"group","label":"Password Reset","link":"/zephr-api-reference/zephr-v5-public-openapi/password-reset","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/password-reset","items":[{"label":"Start password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/password-reset/startpasswordreset","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/password-reset/startpasswordreset","metadata":{"seo":{"title":"Start password reset","description":"Sends a password reset link to your registered email address."}},"httpPath":"/zephr/v5/users/reset"},{"label":"Complete password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/password-reset/completepasswordreset","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/password-reset/completepasswordreset","metadata":{"seo":{"title":"Complete password reset","description":"Set your new password to complete the reset process."}},"httpPath":"/zephr/v5/users/reset/{state}"}]},{"type":"group","label":"Email Update (2-Step Flow)","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(2-step-flow)","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(2-step-flow)","items":[{"label":"Request email change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(2-step-flow)/emailupdate_2step1","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(2-step-flow)/emailupdate_2step1","metadata":{"seo":{"title":"Request email change","description":"Start changing your email address. This step requires an active session."}},"httpPath":"/zephr/v5/users/update-email​"},{"label":"Confirm your new email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(2-step-flow)/emailupdate_2step2","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(2-step-flow)/emailupdate_2step2","metadata":{"seo":{"title":"Confirm your new email","description":"Finish changing your email address. No session is required."}},"httpPath":"/zephr/v5/users/update-email​​"}]},{"type":"group","label":"Email Update (3-Step Flow)","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)","items":[{"label":"Request email change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)/emailupdate_3step1","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)/emailupdate_3step1","metadata":{"seo":{"title":"Request email change","description":"Start changing your email address. This step requires an active session."}},"httpPath":"/zephr/v5/users/update-email​​​"},{"label":"Confirm your current email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)/confirmcurrentemailupdate_3step2","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)/confirmcurrentemailupdate_3step2","metadata":{"seo":{"title":"Confirm your current email","description":"Confirm ownership of your current email as part of an email change."}},"httpPath":"/zephr/v5/users/update-email/{state}"},{"label":"Confirm your new email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)/emailupdate_3step3","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/email-update-(3-step-flow)/emailupdate_3step3","metadata":{"seo":{"title":"Confirm your new email","description":"Finish changing your email address. No session or password is required."}},"httpPath":"/zephr/v5/users/update-email​​​​"}]},{"type":"separator","label":"Users"},{"type":"group","label":"Management","link":"/zephr-api-reference/zephr-v5-public-openapi/user-management","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/user-management","items":[{"label":"Sign up for a new account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/user-management/registeruser","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/user-management/registeruser","metadata":{"seo":{"title":"Sign up for a new account","description":"Create your account. If an unregistered account with this email exists, it will be activated."}},"httpPath":"/zephr/v5/users/register"},{"label":"Add or update a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/user-management/createcontact","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/user-management/createcontact","metadata":{"seo":{"title":"Add or update a contact","description":"Creates a contact, or updates an existing contact, based on email address. Contact management must be enabled for the tenant."}},"httpPath":"/zephr/v5/users/contact"},{"label":"Retrieve your account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/user-management/getuseraccount","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/user-management/getuseraccount","metadata":{"seo":{"title":"Retrieve your account details","description":"View your account details including email and profile information."}},"httpPath":"/zephr/v5/users/me"},{"label":"Close your account and delete your data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/user-management/forgetme","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/user-management/forgetme","metadata":{"seo":{"title":"Close your account and delete your data","description":"Permanently delete all your account data and log out from all devices. You'll be logged out everywhere."}},"httpPath":"/zephr/v5/users/me"}]},{"type":"group","label":"Profile","link":"/zephr-api-reference/zephr-v5-public-openapi/profile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/profile","items":[{"label":"Create or update your profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/profile/createorupdateuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/profile/createorupdateuserprofile","metadata":{"seo":{"title":"Create or update your profile","description":"Change your account details. Add new information or update existing fields."}},"httpPath":"/zephr/v5/users/profile"},{"label":"Retrieve your profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/profile/getuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/profile/getuserprofile","metadata":{"seo":{"title":"Retrieve your profile","description":"View your account details. Includes all your profile information and custom fields."}},"httpPath":"/zephr/v5/users/profile"},{"label":"Replace your profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/profile/updateuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/profile/updateuserprofile","metadata":{"seo":{"title":"Replace your profile","description":"Update your entire profile. Existing attributes not in this request are deleted."}},"httpPath":"/zephr/v5/users/profile"},{"label":"Update specific profile fields","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/profile/patchuserprofile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/profile/patchuserprofile","metadata":{"seo":{"title":"Update specific profile fields","description":"Update specific account fields. New fields are added, existing fields are updated, and other fields stay the same. POST and PATCH work the same way."}},"httpPath":"/zephr/v5/users/profile"}]},{"type":"group","label":"Extended Profile","link":"/zephr-api-reference/zephr-v5-public-openapi/extended-profile","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/extended-profile","items":[{"label":"Get your account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/extended-profile/getextendedprofileforapp","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/extended-profile/getextendedprofileforapp","metadata":{"seo":{"title":"Get your account details","description":"Get custom details about your account. Your organization can add any extra information they want to store here."}},"httpPath":"/zephr/v5/users/profile/{appId}"},{"label":"Delete custom profile data","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-v5-public-openapi/extended-profile/deleteextendedprofileforapp","routeSlug":"/zephr-api-reference/zephr-v5-public-openapi/extended-profile/deleteextendedprofileforapp","metadata":{"seo":{"title":"Delete custom profile data","description":"Deletes the authenticated user's Extended Profile data for a specific app identifier."}},"httpPath":"/zephr/v5/users/profile/{appId}"}]}]},{"type":"group","label":"v4 API","items":[{"type":"link","label":"v4 Public API reference","link":"/zephr-api-reference/zephr-public-api","routeSlug":"/zephr-api-reference/zephr-public-api"},{"type":"group","label":"Authentication","link":"/zephr-api-reference/zephr-public-api/authentication","routeSlug":"/zephr-api-reference/zephr-public-api/authentication","items":[{"label":"Log in to the user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/loginuseraccount","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/loginuseraccount","metadata":{"seo":{"title":"Log in to the user account","description":"This endpoint is utilized for user authentication, granting access to secured endpoints  that mandate authentication. Following successful authentication, a blaize_session is generated  for the user, enabling them to access the secure endpoints."}},"httpPath":"/blaize/login"},{"label":"Log out of the user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/logoutuseraccount","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/logoutuseraccount","metadata":{"seo":{"title":"Log out of the user account","description":"Logs out of the user account."}},"httpPath":"/blaize/logout"},{"label":"Retrieve the SSO status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/retrievessostatus","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/retrievessostatus","metadata":{"seo":{"title":"Retrieve the SSO status","description":"Retrieves the SSO status and metadata of the current user."}},"httpPath":"/zephr/public/sso/v1/status"},{"label":"Update the metadata","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/updatemetadata","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/updatemetadata","metadata":{"seo":{"title":"Update the metadata","description":"Updates the SSO metadata associated with the user."}},"httpPath":"/zephr/public/sso/v1/status/meta"},{"label":"Start the passwordless authentication flow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/startpasswordlessauthentication","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/startpasswordlessauthentication","metadata":{"seo":{"title":"Start the passwordless authentication flow","description":"Starts the passwordless authentication flow by sending an email to the user with a sign-in link. When the user clicks the link, they are directed to GET /blaize/token-exchange?token=..., which authenticates them automatically.IMPORTANT: Passwordless authentication requires the user's email to be verified. This means the user must first receive a separate verification email and click the link to confirm their email address. Verification can be triggered by sending a POST request to the appropriate endpoint."}},"httpPath":"/blaize/token-exchange"},{"label":"Completes the passwordless authentication flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/completepasswordlessauthentication","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/completepasswordlessauthentication","metadata":{"seo":{"title":"Completes the passwordless authentication flow","description":"Completes the passwordless authentication flow. This endpoint is triggered when the the user clicks the link in the email sent after a POST /blaize/token-exchange request.IMPORTANT: For passwordless authentication, first is required to send a POST to request an email to be sent to the User’s email with a link for the user to click on to verify his email."}},"httpPath":"/blaize/token-exchange"},{"label":"Complete a 2FA based password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/complete2fapasswordreset","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/complete2fapasswordreset","metadata":{"seo":{"title":"Complete a 2FA based password reset","description":"Completes the password reset.IMPORTANT: To reset a user's password, first send a POST request to trigger an email with a reset token. This token must be included in the state parameter when calling this API. The validator parameter is optional, if omitted, the OTP can be verified first, and the new password can be submitted separately with the correct OTP."}},"httpPath":"/zephr/users/reset/{state}"},{"label":"Return the password reset form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/resetpasswordform","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/resetpasswordform","metadata":{"seo":{"title":"Return the password reset form","description":"Returns the password reset form"}},"httpPath":"/blaize/blaize/password-reset.html"},{"label":"Create an anonymous session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/createanonymoussession","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/createanonymoussession","metadata":{"seo":{"title":"Create an anonymous session","description":"Creates an anonymous session."}},"httpPath":"/blaize/anonymous-session"},{"label":"Start updating the current email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/startupdatingyourcurrentemailaddress","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/startupdatingyourcurrentemailaddress","metadata":{"seo":{"title":"Start updating the current email address","description":"Starts updating user's current email address."}},"httpPath":"/blaize/users/update-email"},{"label":"Start updating the current email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/startupdatingyourcurrentzephremailaddress","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/startupdatingyourcurrentzephremailaddress","metadata":{"seo":{"title":"Start updating the current email address","description":"Updates the user's email address. The user will receive an email with a one-time password (OTP) to verify the new email address. In order to finish the process, the user must provide the OTP to the /zephr/users/update-email/{otp} endpoint. The difference between this endpoint and the /blaize/users/update-email endpoint is that this endpoint requires the extra layer of authentication through the required validator."}},"httpPath":"/zephr/users/update-email"},{"label":"Complete updating the current email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/completeupdatingyourcurrentzephremailaddress","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/completeupdatingyourcurrentzephremailaddress","metadata":{"seo":{"title":"Complete updating the current email address","description":"Completes updating the user's email address. The user must provide the OTP received in the email to verify the new email address. The difference between this endpoint and the /blaize/users/update-email/ endpoint is that this endpoint requires the extra layer of authentication through the required validator."}},"httpPath":"/zephr/users/update-email/{otp}"},{"label":"Return the update email request form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/updateemailrequestform","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/updateemailrequestform","metadata":{"seo":{"title":"Return the update email request form","description":"Returns the update email request Form."}},"httpPath":"/blaize/update-email.html"},{"label":"Change the user password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/changepassword","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/changepassword","metadata":{"seo":{"title":"Change the user password","description":"Changes the user password."}},"httpPath":"/blaize/users/change-password"},{"label":"Start a 2FA password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/startpasswordreset","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/startpasswordreset","metadata":{"seo":{"title":"Start a 2FA password reset","description":"Starts the password reset for a 2FA user. This will send an email to the user with a 6 digit code, which can then be used to reset their password."}},"httpPath":"/zephr/users/reset"},{"label":"Change the user's password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/authentication/changezephruserpassword","routeSlug":"/zephr-api-reference/zephr-public-api/authentication/changezephruserpassword","metadata":{"seo":{"title":"Change the user's password","description":"This endpoint starts the process of changing a user's password. An active user session is required for this endpoint. This process ends with an OTP (One-time password) being sent to the user's email address."}},"httpPath":"/zephr/users/change-password"}]},{"type":"group","label":"Braintree Payments","link":"/zephr-api-reference/zephr-public-api/braintree-payments","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments","items":[{"label":"Retrieve the Braintree token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/getbraintreetoken","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/getbraintreetoken","metadata":{"seo":{"title":"Retrieve the Braintree token","description":"Issues a Braintree client token for the current blaize session. This holds the user's userId if the user has an authenticated session. This token can be used to request a payment once."}},"httpPath":"/blaize/payment/braintree/token"},{"label":"Create a subscription charged callback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/createsubscriptionchargedcallback","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/createsubscriptionchargedcallback","metadata":{"seo":{"title":"Create a subscription charged callback","description":"This endpoint generates a callback for subscription charges when a product purchase is created, regardless of success or failure. It requires a mandatory string payload containing the bt_signature  and bt_payload parameters.  To use subscriptions, configure the Braintree callback to direct to this endpoint."}},"httpPath":"/blaize/payment/braintree/subscriptionChargedCallback"},{"label":"List the Braintree subscriptions of a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/listuserbraintreesubscriptions","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/listuserbraintreesubscriptions","metadata":{"seo":{"title":"List the Braintree subscriptions of a user","description":"Lists all Braintree subscriptions for the logged-in user."}},"httpPath":"/blaize/payment/braintree/subscriptions"},{"label":"Update the Braintree subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/updatebraintreesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/updatebraintreesubscription","metadata":{"seo":{"title":"Update the Braintree subscription","description":"Updates a Braintree subscription by ID. This operation currently only supports updating the payment method for a subscription, sending the payment method token or nonce."}},"httpPath":"/blaize/payment/braintree/subscriptions/{subscriptionId}"},{"label":"Cancel the Braintree subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/cancelbraintreesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/cancelbraintreesubscription","metadata":{"seo":{"title":"Cancel the Braintree subscription","description":"Cancels a Braintree subscription by ID."}},"httpPath":"/blaize/payment/braintree/subscriptions/{subscriptionId}"},{"label":"Create a Braintree buy (one-off)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/createbraintreebuyoneoff","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/createbraintreebuyoneoff","metadata":{"seo":{"title":"Create a Braintree buy (one-off)","description":"Uses the payment info captured by the braintree drop-in UI and encoded in the payment nonce to create a braintree customer and issue a one-off payment. When braintree responds successfully, the logged-in user will be granted all entitlements in the product's associated bundle."}},"httpPath":"/blaize/payment/braintree/buy"},{"label":"List Braintree payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/listbraintreeuserpaymentmethods","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/listbraintreeuserpaymentmethods","metadata":{"seo":{"title":"List Braintree payment methods","description":"Lists the Braintree payment method details associated with the logged-in user."}},"httpPath":"/zephr/payment/braintree/payment-methods"},{"label":"Create a new Braintree payment method.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/createbraintreeuserpaymentmethod","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/createbraintreeuserpaymentmethod","metadata":{"seo":{"title":"Create a new Braintree payment method.","description":"Creates the Braintree payment method with the associated vaulted nonce, for the authenticated user."}},"httpPath":"/zephr/payment/braintree/payment-methods"},{"label":"Update a Braintree payment method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/updateuserbraintreepaymentmethod","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/updateuserbraintreepaymentmethod","metadata":{"seo":{"title":"Update a Braintree payment method","description":"Updates the Braintree payment method details associated with the logged-in user. The details to update must first be captured from Braintree in a nonce and vaulted."}},"httpPath":"/zephr/payment/braintree/payment-methods/{paymentMethodToken}"},{"label":"Delete the Braintree payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/deleteuserbraintreepaymentmethod","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/deleteuserbraintreepaymentmethod","metadata":{"seo":{"title":"Delete the Braintree payment method","description":"Deletes the Braintree payment method associated with the provided token."}},"httpPath":"/zephr/payment/braintree/payment-methods/{paymentMethodToken}"},{"label":"Set the default Braintree payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/setuserdefaultbraintreepaymentmethod","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/setuserdefaultbraintreepaymentmethod","metadata":{"seo":{"title":"Set the default Braintree payment method","description":"Sets the Braintree default payment method for the logged-in user. This must be a valid payment method already associated with the user."}},"httpPath":"/zephr/payment/braintree/default-payment-method"},{"label":"List all Braintree plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/listbraintreeplans","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/listbraintreeplans","metadata":{"seo":{"title":"List all Braintree plans","description":"Lists the plans associated with the identified product. The product ID is required."}},"httpPath":"/zephr/payment/braintree/plans"},{"label":"Get a Braintree Promo Code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/getbraintreepromocode","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/getbraintreepromocode","metadata":{"seo":{"title":"Get a Braintree Promo Code","description":"Gets a Braintree promo code."}},"httpPath":"/blaize/payment/braintree/promo-code"},{"label":"List Braintree add-ons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/listbraintreeaddons","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/listbraintreeaddons","metadata":{"seo":{"title":"List Braintree add-ons","description":"Lists the Braintree add-ons."}},"httpPath":"/blaize/payment/braintree/addons&promoCode={promoCode}"},{"label":"Start the Braintree subscription (Deprecated)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/braintree-payments/startbraintreesubscriptiondeprecated","routeSlug":"/zephr-api-reference/zephr-public-api/braintree-payments/startbraintreesubscriptiondeprecated","metadata":{"seo":{"title":"Start the Braintree subscription (Deprecated)","description":"** (Deprecated - use the \"/zephr/subscribe\" operation intead)**Uses the payment info captured by the braintree drop-in UI and encoded in the payment nonce to create a braintree customer in with a recurring payment.When braintree responds successfully, the logged-in user will be temporarily granted all entitlements in the product's associated bundle."}},"httpPath":"/blaize/payment/braintree/subscribe"}]},{"type":"group","label":"Browser Feature Transformations","link":"/zephr-api-reference/zephr-public-api/browser-feature-transformations","routeSlug":"/zephr-api-reference/zephr-public-api/browser-feature-transformations","items":[{"label":"Execute Browser feature decisions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/browser-feature-transformations/executebrowserfeaturesdecisions","routeSlug":"/zephr-api-reference/zephr-public-api/browser-feature-transformations/executebrowserfeaturesdecisions","metadata":{"seo":{"title":"Execute Browser feature decisions","description":"Zephr HTML Features can be run in the browser by calling this API directly or using the Zephr Browser SDK. For compatibility with CDN, any web headers (Referrer, User-Agent) will be accepted and passed onto the rule engine."}},"httpPath":"/zephr/feature-decisions"},{"label":"Execute Browser feature transformations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/browser-feature-transformations/executebrowserfeaturetransformations","routeSlug":"/zephr-api-reference/zephr-public-api/browser-feature-transformations/executebrowserfeaturetransformations","metadata":{"seo":{"title":"Execute Browser feature transformations","description":"Zephr HTML Features can be run in the browser by calling this API directly or using the Zephr Browser SDK. For compatibility with CDN, any web headers (Referrer, User-Agent) will be accepted and passed onto the rule engine."}},"httpPath":"/zephr/feature-transformations"}]},{"type":"group","label":"Decision Engine","link":"/zephr-api-reference/zephr-public-api/decision-engine","routeSlug":"/zephr-api-reference/zephr-public-api/decision-engine","items":[{"label":"Execute the Decision Engine","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/decision-engine/executedecisionengine","routeSlug":"/zephr-api-reference/zephr-public-api/decision-engine/executedecisionengine","metadata":{"seo":{"title":"Execute the Decision Engine","description":"The Blaize Decision Engine can be invoked via the Public API to calculate an HTTP Response based upon Request-Level Rules created in the Admin Console. This functionality is built into the Blaize Dynamic CDN but the API variant is useful for CMS or edge side integrations."}},"httpPath":"/blaize/decision-engine"},{"label":"Retrieve the Decision Engine","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/decision-engine/getdecisionengine","routeSlug":"/zephr-api-reference/zephr-public-api/decision-engine/getdecisionengine","metadata":{"seo":{"title":"Retrieve the Decision Engine","description":"For compatibility with CDN, any web headers (Referrer, User-Agent) will be accepted and passed onto the rule engine."}},"httpPath":"/blaize/decision-engine"}]},{"type":"group","label":"Dynamic Offer Decision Engine","link":"/zephr-api-reference/zephr-public-api/dynamic-offer-decision-engine","routeSlug":"/zephr-api-reference/zephr-public-api/dynamic-offer-decision-engine","items":[{"label":"Process dynamic offer decisions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/dynamic-offer-decision-engine/processdynamicofferdecisions","routeSlug":"/zephr-api-reference/zephr-public-api/dynamic-offer-decision-engine/processdynamicofferdecisions","metadata":{"seo":{"title":"Process dynamic offer decisions","description":"The Dynamic Offer Decision Engine can be invoked via the Public API to calculate a decision output response based upon each property rule under the Dynamic Offer created in the Zephr Console."}},"httpPath":"/zephr/public/decisions/v2/dynamic-offers"},{"label":"Validate dynamic offer decisions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/dynamic-offer-decision-engine/validatedynamicofferdecisions","routeSlug":"/zephr-api-reference/zephr-public-api/dynamic-offer-decision-engine/validatedynamicofferdecisions","metadata":{"seo":{"title":"Validate dynamic offer decisions","description":"The Dynamic Offer Decision Engine can be tested via this endpoint to calculate a decision output response based on the criteria of the provided validation ID. Validation criteria is configured on the Zephr Console and determines the version of the dynamic offer being used."}},"httpPath":"/zephr/public/decisions/v2/dynamic-offers/{offerId}/validations/{validationId}"}]},{"type":"group","label":"Dynamic Offer Promo Code Decision","link":"/zephr-api-reference/zephr-public-api/dynamic-offer-promo-code-decision","routeSlug":"/zephr-api-reference/zephr-public-api/dynamic-offer-promo-code-decision","items":[{"label":"Process promo code decisions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/dynamic-offer-promo-code-decision/processpromocodedecisions","routeSlug":"/zephr-api-reference/zephr-public-api/dynamic-offer-promo-code-decision/processpromocodedecisions","metadata":{"seo":{"title":"Process promo code decisions","description":"The Promo Code decision would execute the discount rule defined behind the given promo code, which is configured from the Zephr console.The decision request would require a list of relevant products with its pricing data, typically it would have come from a Dynamic Offer decision response.The Promo Code decision would generate decision response like a regular Dynamic Offer, but with the discount output according to the Promo Code's discount rule."}},"httpPath":"/zephr/public/decisions/v1/promo-codes"}]},{"type":"group","label":"OAuth Flow","link":"/zephr-api-reference/zephr-public-api/oauth-flow","routeSlug":"/zephr-api-reference/zephr-public-api/oauth-flow","items":[{"label":"Start an OAuth flow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/oauth-flow/startoauthflow","routeSlug":"/zephr-api-reference/zephr-public-api/oauth-flow/startoauthflow","metadata":{"seo":{"title":"Start an OAuth flow","description":"Starts the OAuth flow."}},"httpPath":"/blaize/oauth/state"},{"label":"Create a callback for the Google OAuth flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/oauth-flow/creategoogleoauthflow","routeSlug":"/zephr-api-reference/zephr-public-api/oauth-flow/creategoogleoauthflow","metadata":{"seo":{"title":"Create a callback for the Google OAuth flow","description":"Callback for Google OAuth Flow."}},"httpPath":"/blaize/oauth/google/callback"},{"label":"Create a callback for the Facebook OAuth flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/oauth-flow/createfacebookoauthflow","routeSlug":"/zephr-api-reference/zephr-public-api/oauth-flow/createfacebookoauthflow","metadata":{"seo":{"title":"Create a callback for the Facebook OAuth flow","description":"Callback for Facebook OAuth flow."}},"httpPath":"/blaize/oauth/facebook/callback"},{"label":"Create a callback for the Linkedin OAuth flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/oauth-flow/createlinkedinoauthflow","routeSlug":"/zephr-api-reference/zephr-public-api/oauth-flow/createlinkedinoauthflow","metadata":{"seo":{"title":"Create a callback for the Linkedin OAuth flow","description":"Callback for Linkedin OAuth flow."}},"httpPath":"/blaize/oauth/linkedin/callback"}]},{"type":"group","label":"Payments","link":"/zephr-api-reference/zephr-public-api/payments","routeSlug":"/zephr-api-reference/zephr-public-api/payments","items":[{"label":"Start the subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/payments/startsubscription","routeSlug":"/zephr-api-reference/zephr-public-api/payments/startsubscription","metadata":{"seo":{"title":"Start the subscription","description":"Uses the payment info captured by the payment provider drop-in UI and create a customer with a recurring payment. When the payment provider responds successfully, the logged-in user will be temporarily granted all entitlements in the product's associated bundle."}},"httpPath":"/zephr/subscribe"},{"label":"Update the subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/payments/changesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/payments/changesubscription","metadata":{"seo":{"title":"Update the subscription","description":"Updates an existing subscription to change the associated product and plan. Updating the subscription may modify the price of the subscription, and if so the balance will be billed immediately at a pro-rated amount. Parameters specific to the vendor may be specified to change the payment method for the subscription. Changing to a plan with a different billing frequency from the existing subscription is not supported for some payment providers (Braintree)."}},"httpPath":"/zephr/subscriptions/:subscriptionId"}]},{"type":"group","label":"Product Sharing","link":"/zephr-api-reference/zephr-public-api/product-sharing","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing","items":[{"label":"Retrieve the product sharing summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/product-sharing/getproductsharingsummary","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing/getproductsharingsummary","metadata":{"seo":{"title":"Retrieve the product sharing summary","description":"Retrieves a summary of the products that the current user shares with other users, and products that are shared with the current user."}},"httpPath":"/zephr/public/products/v1/shares"},{"label":"Delete the product sharing by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/product-sharing/deleteuserproductsharing","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing/deleteuserproductsharing","metadata":{"seo":{"title":"Delete the product sharing by ID","description":"Deletes a user product share by ID. Pending invites and accepted shares can be deleted. Invoking this method will increase the number of shares that the user has available for the given product. If the sharing_id corresponds to an accepted share, the member will immediately lose access to the product unless they have separate access. The member will receive an email notification about their removal.  This email can be configured in the Admin Console."}},"httpPath":"/zephr/public/products/v1/shares/{sharing_id}"},{"label":"Create a product sharing invite via Email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/product-sharing/createproductsharinginviteviaemail","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing/createproductsharinginviteviaemail","metadata":{"seo":{"title":"Create a product sharing invite via Email","description":"Creates a new user product share and send it via email. The exact contents of this email are configurable in the admin console. The email may include a link composed of the required attribute base_url and an additional path parameter sharing_id. It is expected that the specified base_url will direct invite recipients to a page that allows them to accept the invite and register/login. Custom metadata can also be passed to this method, which will be made available in the invitation email template and any later calls to access the publicly available share data. This metadata can be used, for example, to include the product owner's first name and a personalised message that is shown to the recipient in the invitation email and in a screen that allows the recipient to accept the invite. Invoking this method will reduce the number of shares that the user has available for the given product. The specified product must be shareable, the current user must have active grants for the product and must not have already exceeded the configured maximum number of shares for the product."}},"httpPath":"/zephr/public/products/v1/shares/invitations/emails"},{"label":"Create a product share invite token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/product-sharing/createproductshareinvitetoken","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing/createproductshareinvitetoken","metadata":{"seo":{"title":"Create a product share invite token","description":"Creates a new user product share. Invoking this method will reduce the number of shares that the user has available for the given product. The returned token sharing ID can later be passed to the accept invite method. Custom metadata can also be passed to this method, which will be made available in later calls to access the publicly available share data. This metadata can be used, for example, to include the product owner's first name and a personalised message that is shown to the recipient in a screen that allows the recipient to accept the invite. Invoking this method will reduce the number of shares that the user has available for the given product. The specified product must be shareable, the current user must have active grants for the product and must not have already exceeded the configured maximum number of shares for the product."}},"httpPath":"/zephr/public/products/v1/shares/invitations/tokens"},{"label":"Retrieve the product share invite public data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/product-sharing/getproductshareinvitepublicdata","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing/getproductshareinvitepublicdata","metadata":{"seo":{"title":"Retrieve the product share invite public data","description":"Retrieves the publicly accessible data relating to a user product share invite. This can be used to inform the invitee of the details of the product that is being shared, and any meta_data added at the point of invite creation, such as the name of the user that sent the invite.This endpoint is not authenticated. The information provided by this endpoint is available to anyone with a valid sharing_id.Invoking this endpoint too rapidly will result in a 429 error response."}},"httpPath":"/zephr/public/products/v1/shares/invitations/{sharing_id}"},{"label":"Accept a product share invite","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/product-sharing/acceptproductshareinvite","routeSlug":"/zephr-api-reference/zephr-public-api/product-sharing/acceptproductshareinvite","metadata":{"seo":{"title":"Accept a product share invite","description":"Accepts a product sharing invite. The current user will gain access to the product linked to the sharing invite. The user that send the invite must have an active grant for the product at the point of acceptance. If the current user already has a product share for the same product from the same product owner, an error code 409 will be returned and the invite will not be accepted."}},"httpPath":"/zephr/public/products/v1/shares/invitations/{sharing_id}"}]},{"type":"group","label":"SDK Feature Decision Engine","link":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine","routeSlug":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine","items":[{"label":"Process multiple decisions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine/processmultipledecisions","routeSlug":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine/processmultipledecisions","metadata":{"seo":{"title":"Process multiple decisions","description":"Processes multiple decisions. The SDK Feature Decision Engine can be invoked via the Public API to calculate a decision output response based upon Feature SDK Rules created in the Zephr Console."}},"httpPath":"/zephr/decide"},{"label":"Process a single decision","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine/processsingledecision","routeSlug":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine/processsingledecision","metadata":{"seo":{"title":"Process a single decision","description":"Processes a single SDK feature decision. An SDK feature rule can be configured in the console, and allows a custom decision to be made using a range of inputs to drive the behaviour of a website or app. SDK features can output any one of several data types as configured in the console."}},"httpPath":"/zephr/decision-engine"},{"label":"Retrieve a single decision","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine/getsingledecision","routeSlug":"/zephr-api-reference/zephr-public-api/sdk-feature-decision-engine/getsingledecision","metadata":{"seo":{"title":"Retrieve a single decision","description":"For compatibility with CDN, any web headers (Referrer, User-Agent) will be accepted and passed onto the rule engine"}},"httpPath":"/zephr/decision-engine"}]},{"type":"group","label":"Sessions","link":"/zephr-api-reference/zephr-public-api/sessions","routeSlug":"/zephr-api-reference/zephr-public-api/sessions","items":[{"label":"List all the user sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/sessions/listusersessions","routeSlug":"/zephr-api-reference/zephr-public-api/sessions/listusersessions","metadata":{"seo":{"title":"List all the user sessions","description":"Lists of all sessions for the current user and site."}},"httpPath":"/zephr/public/sessions/v1/sessions"},{"label":"Delete all other sessions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/sessions/deleteallothersessions","routeSlug":"/zephr-api-reference/zephr-public-api/sessions/deleteallothersessions","metadata":{"seo":{"title":"Delete all other sessions","description":"Deletes all sessions for the current user and site apart from the session used to make the request."}},"httpPath":"/zephr/public/sessions/v1/sessions"},{"label":"Delete the session by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/sessions/deletesession","routeSlug":"/zephr-api-reference/zephr-public-api/sessions/deletesession","metadata":{"seo":{"title":"Delete the session by ID","description":"Deletes a session by ID. Returns a 404 if the specified session does not exist or does not belong to the current user."}},"httpPath":"/zephr/public/sessions/v1/sessions/{sessionId}"}]},{"type":"group","label":"Stripe Payments","link":"/zephr-api-reference/zephr-public-api/stripe-payments","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments","items":[{"label":"Retrieve the Stripe public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/getstripepublickey","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/getstripepublickey","metadata":{"seo":{"title":"Retrieve the Stripe public key","description":"This API endpoint fetches the public key associated with a tenant for payment processing. If the user is authenticated and the tenant has a configured Stripe public key, the endpoint will return the Stripe public key in a String format."}},"httpPath":"/blaize/payment/stripe/publicKey"},{"label":"Create a Stripe setup intent secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/createstripesetupintentsecret","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/createstripesetupintentsecret","metadata":{"seo":{"title":"Create a Stripe setup intent secret","description":"Creates the client secret to update card details"}},"httpPath":"/zephr/payment/stripe/setupIntentSecret"},{"label":"Start the Stripe subscription confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/startstripesubscriptionconfirmation","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/startstripesubscriptionconfirmation","metadata":{"seo":{"title":"Start the Stripe subscription confirmation","description":"If a payment requires confirmation (3dSecure etc), the payment is confirmed in the front end."}},"httpPath":"/blaize/payment/stripe/subscription/confirmation"},{"label":"Update the Stripe subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/updatestripesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/updatestripesubscription","metadata":{"seo":{"title":"Update the Stripe subscription","description":"Updates the payment method in the subscription. Payment method id will be provided by stripe on updating card details in the front end."}},"httpPath":"/zephr/payment/stripe/updateSubscription"},{"label":"Create a Stripe one-off payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/buystripe","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/buystripe","metadata":{"seo":{"title":"Create a Stripe one-off payment","description":"Uses the payment method collected by Stripe Elements to create a one off payment."}},"httpPath":"/blaize/payment/stripe/buy"},{"label":"Receive a webhook from Stripe for when a user is charged for a subscription.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/callbackstripesubscriptioncharged","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/callbackstripesubscriptioncharged","metadata":{"seo":{"title":"Receive a webhook from Stripe for when a user is charged for a subscription.","description":"To use subscriptions, Stripe Webhooks for invoice.payment_succeeded must be configured to point to this endpoint."}},"httpPath":"/blaize/payment/stripe/subscriptionChargedCallback"},{"label":"Preview the Stripe subscription change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/previewstripechangesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/previewstripechangesubscription","metadata":{"seo":{"title":"Preview the Stripe subscription change","description":"Generates a preview of the invoice that Stripe will create for the customer if theirsubscription is changed to a new plan. The invoice will be a prorated invoice for theprice difference between current and new subscription plans for the remainder of the current billing period.The invoice will be billed immediately upon changing subscription.The invoice amount may be negative if the customer is changing to a lower-priced plan."}},"httpPath":"/zephr/payment/stripe/subscription/{subscriptionId}/change-previews"},{"label":"Preview the Stripe subscription price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/previewstripesubscriptionprice","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/previewstripesubscriptionprice","metadata":{"seo":{"title":"Preview the Stripe subscription price","description":"Generates a preview of the total price and tax amount that Stripe will charge the customer if theycreate a new subscription for the specified plan."}},"httpPath":"/zephr/payment/stripe/create-subscription-previews"},{"label":"Check a Stripe promo code for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/checkstripepromocode","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/checkstripepromocode","metadata":{"seo":{"title":"Check a Stripe promo code for a user","description":"Checks a Stripe promo code for the logged in user. The promo code is checked for validity of the current user based on first time order restriction, specific customer restriction, max allowed redemptions and expiration. The payment form payment options are checked to match the minimum payment amount requirements of the promo code."}},"httpPath":"/zephr/payment/stripe/promo-code"},{"label":"Check a Stripe promo code for a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/checkstripepromocodewithpaymentoptions","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/checkstripepromocodewithpaymentoptions","metadata":{"seo":{"title":"Check a Stripe promo code for a user","description":"Checks a Stripe promo code for the logged in user. The promo code is checked for validity of the current user based on first time order restriction, specific customer restriction, max allowed redemptions and expiration. The supplied payment payment options are checked to match the minimum payment amount requirements of the promo code."}},"httpPath":"/zephr/payment/stripe/promo-code-check"},{"label":"Start the Stripe subscription (Deprecated)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/startstripesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/startstripesubscription","metadata":{"seo":{"title":"Start the Stripe subscription (Deprecated)","description":"(Deprecated - use /zephr/subscribe)Uses the payment method info captured by the Stripe Elements UI to create a Stripe customer with a recurring payment.When Stripe responds successfully, the logged-in user will be temporarily granted all entitlements in the product's associated bundle."}},"httpPath":"/blaize/payment/stripe/subscribe"},{"label":"List the user's Stripe subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/liststripesubscriptions","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/liststripesubscriptions","metadata":{"seo":{"title":"List the user's Stripe subscriptions","description":"Lists the user's Stripe subscriptions."}},"httpPath":"/blaize/payment/stripe/subscriptions"},{"label":"Cancel a user's Stripe subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/stripe-payments/cancelstripesubscription","routeSlug":"/zephr-api-reference/zephr-public-api/stripe-payments/cancelstripesubscription","metadata":{"seo":{"title":"Cancel a user's Stripe subscription","description":"Cancels a user's Stripe subscription"}},"httpPath":"/blaize/payment/stripe/subscriptions/{externalId}"}]},{"type":"group","label":"Third-Party Authentication","link":"/zephr-api-reference/zephr-public-api/third-party-authentication","routeSlug":"/zephr-api-reference/zephr-public-api/third-party-authentication","items":[{"label":"Start an authorization code flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/third-party-authentication/startoauth2flow","routeSlug":"/zephr-api-reference/zephr-public-api/third-party-authentication/startoauth2flow","metadata":{"seo":{"title":"Start an authorization code flow","description":"Starts OAuth2 Authorization Code Flow. The resource owner will be authenticated and be presented with the third-party application access request."}},"httpPath":"/zephr/oauth2"},{"label":"Returns a list of your user's access scopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/third-party-authentication/listoauth2consentflow","routeSlug":"/zephr-api-reference/zephr-public-api/third-party-authentication/listoauth2consentflow","metadata":{"seo":{"title":"Returns a list of your user's access scopes","description":"Returns a list of your user's access scopes"}},"httpPath":"/zephr/oauth2/consent/{clientId}"},{"label":"Grant the access request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/third-party-authentication/grantaccessrequest","routeSlug":"/zephr-api-reference/zephr-public-api/third-party-authentication/grantaccessrequest","metadata":{"seo":{"title":"Grant the access request","description":"The resource owner will consent or deny the third party application access request, and Zephr will return an authorization code upon user's consent."}},"httpPath":"/zephr/oauth2/grant"},{"label":"Retrieves the oauth2 configured fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/third-party-authentication/getoauth2config","routeSlug":"/zephr-api-reference/zephr-public-api/third-party-authentication/getoauth2config","metadata":{"seo":{"title":"Retrieves the oauth2 configured fields","description":"Gets the public oauth2 fields configured on the Third Party Authentication section of the site"}},"httpPath":"/zephr/oauth2/config"},{"label":"Get the OAuth2 error page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/third-party-authentication/getoauth2errorpage","routeSlug":"/zephr-api-reference/zephr-public-api/third-party-authentication/getoauth2errorpage","metadata":{"seo":{"title":"Get the OAuth2 error page","description":"Gets the OAuth2 error page."}},"httpPath":"/zephr/oauth2/error"}]},{"type":"group","label":"User","link":"/zephr-api-reference/zephr-public-api/user","routeSlug":"/zephr-api-reference/zephr-public-api/user","items":[{"label":"Register a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/registerusers","routeSlug":"/zephr-api-reference/zephr-public-api/user/registerusers","metadata":{"seo":{"title":"Register a user","description":"This endpoint enables clients to initiate the creation of a new user account. If a contact with an identical  email address already exists, that contact will be elevated to the status of a registered user.  Essential attributes like identifiers.email_address and validators.password are mandatory for this endpoint.  If any of these attributes are absent, registration attempts will trigger an error.  Upon a successful request, session cookies like blaize_session and blaize_tracking_id are generated and  included in the response header."}},"httpPath":"/blaize/register"},{"label":"Create or Update a Contact User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/createcontact","routeSlug":"/zephr-api-reference/zephr-public-api/user/createcontact","metadata":{"seo":{"title":"Create or Update a Contact User","description":"This endpoint creates a new contact user or updates the attributes of an existing contact user if one exists with the supplied email address. To use this endpoint, 'contact users' must be enabled in the identity settings page in the console. A contact user is a type of user that has no validators and so no ability to create authenticated sessions. Contact users can be created to capture user information, such as email addresses, without fully registering users. This endpoint cannot be used to update the attributes of a registered user. Attempting to do so will return a 409 response. After creating a contact with an anonomyous session, the session is updated to include a flag to identify that this has happened. In the rules builder, the 'Contact Capture' decision node can be used to test this flag value and so determine if the current anonymous session was used to create a contact. This can be used, for example, to prevent showing a contact form to anonymous users that have already filled in such a form."}},"httpPath":"/zephr/createContact"},{"label":"Delete the user data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/deleteuserdata","routeSlug":"/zephr-api-reference/zephr-public-api/user/deleteuserdata","metadata":{"seo":{"title":"Delete the user data","description":"Deletes user related data like sessions, elasticSearch data, O2Auth tokens according to the provided user_id in the session cookie."}},"httpPath":"/blaize/forget-me"},{"label":"Retrieve the account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/retrieveaccount","routeSlug":"/zephr-api-reference/zephr-public-api/user/retrieveaccount","metadata":{"seo":{"title":"Retrieve the account","description":"Retrieves the user's core account details."}},"httpPath":"/blaize/account"},{"label":"Retrieves the attributes for an authenticated user in the Zephr user store.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/retrieveprofile","routeSlug":"/zephr-api-reference/zephr-public-api/user/retrieveprofile","metadata":{"seo":{"title":"Retrieves the attributes for an authenticated user in the Zephr user store.","description":"Retrieves the attributes for an authenticated user in the Zephr user store. In addition to the standard authenticators, this endpoint also accepts an OAuth bearer token through the Authorization header. The response will only include publicly accessible user attributes."}},"httpPath":"/blaize/profile"},{"label":"Sets the attributes for an authenticated user in the Zephr user store.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/saveprofile","routeSlug":"/zephr-api-reference/zephr-public-api/user/saveprofile","metadata":{"seo":{"title":"Sets the attributes for an authenticated user in the Zephr user store.","description":"Sets the attributes for an authenticated user in the Zephr user store. The provided attributes are saved for the user. Any existing attributes for the user are removed and replaced with this new set."}},"httpPath":"/blaize/profile"},{"label":"Updates the attributes for an authenticated user in the Zephr user store.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/updateprofile","routeSlug":"/zephr-api-reference/zephr-public-api/user/updateprofile","metadata":{"seo":{"title":"Updates the attributes for an authenticated user in the Zephr user store.","description":"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."}},"httpPath":"/blaize/profile"},{"label":"Updates the attributes for an authenticated user in the Zephr user store.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/updateprofilepatch","routeSlug":"/zephr-api-reference/zephr-public-api/user/updateprofilepatch","metadata":{"seo":{"title":"Updates the attributes for an authenticated user in the Zephr user store.","description":"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."}},"httpPath":"/blaize/profile"},{"label":"Retrieve Extended Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/retrieveextendedprofile","routeSlug":"/zephr-api-reference/zephr-public-api/user/retrieveextendedprofile","metadata":{"seo":{"title":"Retrieve Extended Profile","description":"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."}},"httpPath":"/blaize/profile/{appId}"},{"label":"Save Extended Profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/saveextendedprofile","routeSlug":"/zephr-api-reference/zephr-public-api/user/saveextendedprofile","metadata":{"seo":{"title":"Save Extended Profile","description":"Extended Profile is used to store additional user information that is not part of the core profile. This endpoint will create an Extended Profile for the App ID if one did not exist already, or overwrite an existing Extended Profile for the App ID. The body can be any valid JSON."}},"httpPath":"/blaize/profile/{appId}"},{"label":"Create an authorization challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/createauthorizationchallenge","routeSlug":"/zephr-api-reference/zephr-public-api/user/createauthorizationchallenge","metadata":{"seo":{"title":"Create an authorization challenge","description":"Authorization Challenge against array of entitlement IDs."}},"httpPath":"/blaize/authorization/challenge"},{"label":"Retrieve the user schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/retrieveuserschema","routeSlug":"/zephr-api-reference/zephr-public-api/user/retrieveuserschema","metadata":{"seo":{"title":"Retrieve the user schema","description":"Retrieves the user attribute schema for the tenant. This includes all fields configured in the admin console for the user schema."}},"httpPath":"/blaize/schema/users"},{"label":"Fingerprint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/browserfingerprint","routeSlug":"/zephr-api-reference/zephr-public-api/user/browserfingerprint","metadata":{"seo":{"title":"Fingerprint","description":"Returns an HTML page that fingerprints the user's browser, sends the fingerprint data to POST /blaize/anonymous-session, and then redirects the user to a specified path provided as a query parameter (defaulting to '/')."}},"httpPath":"/blaize/browser-fingerprint"},{"label":"Start the email update flow for a passwordless user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/startupdateemailpasswordless","routeSlug":"/zephr-api-reference/zephr-public-api/user/startupdateemailpasswordless","metadata":{"seo":{"title":"Start the email update flow for a passwordless user","description":"Starts the email update flow for a passwordless user. An email will be sent to the new email address for verification."}},"httpPath":"/blaize/users/update-email-passwordless/{state}"},{"label":"Start two factor authentication process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/start2fa","routeSlug":"/zephr-api-reference/zephr-public-api/user/start2fa","metadata":{"seo":{"title":"Start two factor authentication process","description":"Starts the two factor authentication process. An email will be sent to the email address provided in the request with a link to complete the process."}},"httpPath":"/blaize/two-factor-authentication"},{"label":"Recognise the user as a previously logged-in user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/recogniseuser","routeSlug":"/zephr-api-reference/zephr-public-api/user/recogniseuser","metadata":{"seo":{"title":"Recognise the user as a previously logged-in user","description":"Recognises the user as a previously logged-in user. Users can be fingerprinted on login based on their email address, their user agent and their IP address. This endpoint can then be used with the same parameters to give users a limited access to their logged-in experience. This is an opt-in feature."}},"httpPath":"/zephr/recognise-me"},{"label":"Complete the change password flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/user/changecompletepasswordflow","routeSlug":"/zephr-api-reference/zephr-public-api/user/changecompletepasswordflow","metadata":{"seo":{"title":"Complete the change password flow","description":"Complete the change password flow. This endpoint changes the password to the one submitted previously in another request. The otp in this request is used to match this request with the previous one that started the flow and submitted the new password."}},"httpPath":"/zephr/users/change-password/{otp}"}]},{"type":"group","label":"V4 Gifts","link":"/zephr-api-reference/zephr-public-api/v4-gifts","routeSlug":"/zephr-api-reference/zephr-public-api/v4-gifts","items":[{"label":"Create a gift V4","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/v4-gifts/createv4gift","routeSlug":"/zephr-api-reference/zephr-public-api/v4-gifts/createv4gift","metadata":{"seo":{"title":"Create a gift V4","description":"Creates a gift (V4)."}},"httpPath":"/zephr/public/gift-tokens/v1/gift-tokens"}]},{"type":"group","label":"Web Analytics","link":"/zephr-api-reference/zephr-public-api/web-analytics","routeSlug":"/zephr-api-reference/zephr-public-api/web-analytics","items":[{"label":"Retrieve the datalayer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/web-analytics/getdatalayer","routeSlug":"/zephr-api-reference/zephr-public-api/web-analytics/getdatalayer","metadata":{"seo":{"title":"Retrieve the datalayer","description":"Retrieves the Datalayer object for the current session. The datalayer can be used to provide contextual data when tracking user activity, for example providing values for 'User Attributes' in hotjar. The /blaize/profile endpoint is preferred for retrieving complete user profile information.  All fields configured in the admin console will be resolved against the current session and returned.  The top-level property in the response object defaults to 'dataLayer' and can be configured in the console under the data layer settings using the 'Data Layer Name' field.  Data layer fields can be grouped by their 'Entity' as configured in the console. An example of the possible groupings is included."}},"httpPath":"/blaize/datalayer"},{"label":"Submit user conversion data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/web-analytics/submituserconversiondata","routeSlug":"/zephr-api-reference/zephr-public-api/web-analytics/submituserconversiondata","metadata":{"seo":{"title":"Submit user conversion data","description":"Records a user conversion.  In Zephr, a conversion typically represents a user state change, such as transitioning from anonymous to registered or becoming a paying customer. This endpoint can also be used to record any event, like a user clicking on an advert. Conversions are tracked against specific rule versions and outcomes, enabling performance comparison between different outcomes.   Recording this data enables the comparison of performance of different outcomes in a rule. For example, a split test could be set up with two slightly different 'advert' outcomes that each record a conversion when a user interacts with them. After traffic has been processed by the rule, the conversion rates between the two outcomes can be compared in 'analytics' mode in the console. For example, it might show that 5% of users who saw Outcome1 clicked a button, compared to 8% for Outcome2. This analytics data can be downloaded in CSV format for further analysis.  Conversion data is only used to evaluate the performance of outcomes in rules and cannot be accessed on a per-user basis. To track if a particular registered user has interacted with an outcome, update a user attribute value.  This endpoint is only relevant where the Zephr in-rule analytics feature is enabled.  This endpoint must be called with a populated blaize_tracking_id cookie.If this cookie is missing, a 400 response code is returned."}},"httpPath":"/zephr/public/rule-outcomes/v1/conversions"}]},{"type":"group","label":"Zephr Features","link":"/zephr-api-reference/zephr-public-api/zephr-features","routeSlug":"/zephr-api-reference/zephr-public-api/zephr-features","items":[{"label":"Retrieve the Zephr Feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/zephr-features/retrievezephrfeature","routeSlug":"/zephr-api-reference/zephr-public-api/zephr-features/retrievezephrfeature","metadata":{"seo":{"title":"Retrieve the Zephr Feature","description":"Retrieves the Zephr browser features by default, or optionally with query parameter ?ruleType returns the given type, they can be HTML, browser, JSON, SDK."}},"httpPath":"/zephr/features"}]},{"type":"group","label":"Component Library","link":"/zephr-api-reference/zephr-public-api/component-library","routeSlug":"/zephr-api-reference/zephr-public-api/component-library","items":[{"label":"Retrieve the Component Library","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/component-library/retrievecomponentlibrary","routeSlug":"/zephr-api-reference/zephr-public-api/component-library/retrievecomponentlibrary","metadata":{"seo":{"title":"Retrieve the Component Library","description":"Components configured in the component library can be retrieved as rendered HTML. The componentId passed in the path can be versioned to reference a specific version of a library component. For example, ‘payment-form:1’, ‘payment-form:4’ or ‘payment-form:active’ to reference the default version of the component."}},"httpPath":"/zephr/public/component-library/v1/library-components/{componentId}"},{"label":"Retrieve the Template Components","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/component-library/retrievetemplatecomponents","routeSlug":"/zephr-api-reference/zephr-public-api/component-library/retrievetemplatecomponents","metadata":{"seo":{"title":"Retrieve the Template Components","description":"Template components can be retrieved as rendered HTML. This endpoint is intended to be consumed by callers processing the output of an SDK TRANSFORMATION rule, where templateConfigId will identify a particular instance of a template component being used in an outcome with variables specified."}},"httpPath":"/zephr/public/template-components/v1/template-components/{templateConfigId}"},{"label":"Retrieve the UI Components","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/component-library/retrieveuicomponents","routeSlug":"/zephr-api-reference/zephr-public-api/component-library/retrieveuicomponents","metadata":{"seo":{"title":"Retrieve the UI Components","description":"UI components can be retrieved as rendered HTML. This endpoint is intended to be consumed by callers processing the output of an SDK TRANSFORMATION rule, where componentId will reference a form or custom component created within an outcome of a rule."}},"httpPath":"/zephr/public/ui-components/v1/ui-components/{componentId}"},{"label":"Retrieve a form by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/component-library/getform","routeSlug":"/zephr-api-reference/zephr-public-api/component-library/getform","metadata":{"seo":{"title":"Retrieve a form by ID","description":"Retrieves a form by ID and returns an HTML page that renders it."}},"httpPath":"/zephr/public/forms/v1/forms/{formId}"},{"label":"List custom components","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/component-library/retrievecustomcomponents","routeSlug":"/zephr-api-reference/zephr-public-api/component-library/retrievecustomcomponents","metadata":{"seo":{"title":"List custom components","description":"Custom components can be retrieved as rendered HTML. This endpoint is intended to be consumed by callers processing the output of an SDK TRANSFORMATION rule, where internalTemplateUsageId will identify a particular instance of a custom component being used in an outcome with variables specified. The variables used by the custom component can be passed in as query parameters with the request which will override the values provided in the rule."}},"httpPath":"/zephr/public/internal-templates/v1/internal-templates/{internalTemplateUsageId}"}]},{"label":"Change the Stripe subscription price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/other/previeweditstripesubscriptionprice","routeSlug":"/zephr-api-reference/zephr-public-api/other/previeweditstripesubscriptionprice","metadata":{"seo":{"title":"Change the Stripe subscription price","description":"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."}},"httpPath":"/zephr/payment/stripe/subscriptions/{externalId}/change-previews"},{"type":"group","label":"Oauth2 Access Token","link":"/zephr-api-reference/zephr-public-api/oauth2-access-token","routeSlug":"/zephr-api-reference/zephr-public-api/oauth2-access-token","items":[{"label":"Request oauth2 access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/oauth2-access-token/requestoauth2accesstoken","routeSlug":"/zephr-api-reference/zephr-public-api/oauth2-access-token/requestoauth2accesstoken","metadata":{"seo":{"title":"Request oauth2 access token","description":"Facilitates the acquisition of an OAuth2 access token.  It requires either a basic authorization header or a client_id provided in the request body."}},"httpPath":"/zephr/oauth2/token"}]},{"type":"group","label":"Subscription","link":"/zephr-api-reference/zephr-public-api/subscription","routeSlug":"/zephr-api-reference/zephr-public-api/subscription","items":[{"label":"Cancel a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-public-api/subscription/cancelsubscription","routeSlug":"/zephr-api-reference/zephr-public-api/subscription/cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"It cancels the logged in user's subscription with the provided external identifier (extenalId). A logged in session is required for this operation."}},"httpPath":"/zephr/subscriptions/{externalId}"}]}]}]},{"type":"separator","label":"CHANGELOGS"},{"type":"group","label":"Admin API changelogs","items":[{"type":"link","fsPath":"docs/get-started/changelogs/admin-v5-api-changelog.md","metadata":{"type":"markdown"},"label":"v5 API","link":"/docs/get-started/changelogs/admin-v5-api-changelog"},{"type":"link","fsPath":"docs/get-started/changelogs/admin-api-changelog.md","metadata":{"type":"markdown"},"label":"v4 API","link":"/docs/get-started/changelogs/admin-api-changelog"}]},{"type":"group","label":"Public API changelogs","items":[{"type":"link","fsPath":"docs/get-started/changelogs/public-v5-api-changelog.md","metadata":{"type":"markdown"},"label":"v5 API","link":"/docs/get-started/changelogs/public-v5-api-changelog"},{"type":"link","fsPath":"docs/get-started/changelogs/public-api-changelog.md","metadata":{"type":"markdown"},"label":"v4 API","link":"/docs/get-started/changelogs/public-api-changelog"}]}]}