Contains operations on the Account User resource.
Admin API reference
/- Delete an end user by primary ID or foreign key
Inserts or updates a foreign key
List users
Create a user
Retrieve a user
Delete a user
Update all user attributes
Update user attributes
Retrieve Extended User Profiles
Update users in bulk
List all bulk user update jobs
Retrieves a bulk user update job
Create a user segment
List user segments
Retrieve a user segment
Delete a user segment
List user segments for a user
Start an email address update
Start a password reset
Start a passwordless authentication
List user sessions
List user accounts
Refresh a access model
Reset a legacy password
Delete an end user by pri...
Admin API Reference (2026-03-27)
The Zephr Admin API provides RESTful access to all Zephr functionality. It is designed for server-side integrations. All requests must be signed as described in HMAC Request Signing and Key Pairs.
The Admin API uses a base URL with the following format: https://{tenantId}.api.zephr.com
Note: If you have multiple tenants, the current tenant ID is shown in a blue box in the top right of the Admin Console. If you have a single site, you can find the tenant ID by navigating to your site domains. To do this, select Sites from the Delivery menu, select your site, and then click the Site Domains button. The tenant ID is the first part of the domain. For example, if the domain is news-paper.cdn.zephr.com, the tenant ID is news.
Request
Deletes an end user and associated data from the system.
This endpoint applies to end users (C2 users), not admin users.
You must provide exactly one of the following identifier options: Option A — Delete by primary ID
primary_idOption B — Delete by foreign keyforeign[system]andforeign[key]
Rules
- Provide either
primary_idor bothforeign[system]andforeign[key]. - Do not provide both identifier options in the same request.
- If parameters are missing, incomplete, or conflicting, the API returns 400.
Important:
To delete JWT users who do not have a foreign system mapping (for example, users whose data exists in DynamoDB but not in the SQL database), provide zephr as the value for the foreign[system] parameter.
Examples:
Delete by primary ID:
DELETE /zephr/integration/users/v1/users?primary_id=123456Delete by foreign key:
DELETE /zephr/integration/users/v1/users?foreign[system]=my-system&foreign[key]=alexuser-12345Delete JWT user with no foreign mapping (DynamoDB-only):
DELETE /zephr/integration/users/v1/users?foreign[system]=zephr&foreign[key]=alexuser-12345
Security
ZephrHmacHttp
Query
The Zephr internal primary user ID of the user to be deleted. Provide this parameter only when deleting by primary ID (Option A).
Example: primary_id=123456
The configured foreign key system defined in the JWT settings. Required when deleting by foreign key (Option B).
Example: foreign[system]=zephr
- https://demo.api.zephr.com/zephr/integration/users/v1/users
- Payload
- cURL
No request payloadQuery
Email address of the user to search for.
Example: identifiers.email_address=example@example.com
Username of the user to search for.
Example: identifiers.username=username
Foreign key of the user to search for. The foreign system is parsed as the remainder of the parameter key name following 'foreign_id.'
Example: foreign_key.xxx=123abc
Performs a general search for the specified value across multiple fields, including attributes.
Example: search=abc
- https://demo.api.zephr.com/v3/users
- Payload
- cURL
No request payloadResponse
application/json
{ "results": [ { … } ] }
- https://demo.api.zephr.com/zephr/public/template-components/v1/template-components/{templateConfigId}
- Payload
- cURL
No request payload