Delete an end user by primary ID or foreign key

Admin API reference

v4 API

Delete an end user by primary ID or foreign key

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_id Option B — Delete by foreign key
foreign[system] and foreign[key]

Rules

Provide either primary_id or both foreign[system] and foreign[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=123456
Delete by foreign key: DELETE /zephr/integration/users/v1/users?foreign[system]=my-system&foreign[key]=alexuser-12345
Delete JWT user with no foreign mapping (DynamoDB-only):
DELETE /zephr/integration/users/v1/users?foreign[system]=zephr&foreign[key]=alexuser-12345

Security

ZephrHmacHttp

Query

primary_idstring

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

foreign[system]string

The configured foreign key system defined in the JWT settings. Required when deleting by foreign key (Option B).

Example:foreign[system]=zephr

foreign[key]string

The external persistent user identifier linked to the user (from the JWT). Required when deleting by foreign key (Option B).

Example:foreign[key]=user_998877

cURL

curl -i -X DELETE \
  'https://demo.api.zephr.com/zephr/integration/users/v1/users?primary_id=123456&foreign%5Bsystem%5D=zephr&foreign%5Bkey%5D=user_998877' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

Deleted successfully (no content).