Remove user metadata
Deletes metadata for the specified UUID.
Note: Enabling referential integrity on your app’s keyset in the Admin Portal ensures that deleting a user entity automatically deletes any memberships related to this user.
| Path Parameters |
|---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. |
uuid string — REQUIREDA UTF-8 encoded string used to identify the client. Must not be empty and can contain up to 92 UTF-8 byte sequences. Prohibited characters are: |
| Query Parameters |
|---|
auth stringString which is either the auth key (Access Manager legacy) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Authorization token with permissions to perform the request. |
signature stringSignature used to verify that the request was signed with the secret key associated with the subscribe key. If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.
Required if |
| Responses | |||||||||
|---|---|---|---|---|---|---|---|---|---|
200Successfully deleted UUID metadata.
| |||||||||
403Disabled - The subscribe key doesn't have App Context API enabled. Forbidden - The client isn't authorized to perform this operation. The authorization key you provided doesn't have the required permissions for this operation.
| |||||||||
412Conditional operation cannot be performed because the target resource has changed since the last retrieval.
| |||||||||
429Request rate limit exceeded.
| |||||||||
500An internal server error occurred.
| |||||||||
503Request processing exceeded the maximum allowed time.
|
sub_key*uuid*Prohibited characters are:
,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero.authsignatureIf Access Manager is enabled, either a valid authorization token or a signature are required.
Check Access Manager documentation for details on how to compute the signature.
timestampRequired if
signature parameter is supplied.statusdatastatuserror{
"status": 403,
"error": {
"message": "Invalid signature",
"source": "authz",
"details": [
{
"message": "Client and server produced different signatures for the same inputs.",
"location": "signature",
"locationType": "query"
}
]
}
}statuserror{
"status": 412,
"error": {
"message": "Resource already changed by another request since the last retrieval.",
"source": "metadata"
}
}statuserror{
"status": 429,
"error": {
"message": "You have exceeded the maximum number of requests per second allowed for your subscribe key.",
"source": "metadata"
}
}statuserror{
"status": 500,
"error": {
"message": "An unexpected error occurred while processing the request.",
"source": "metadata"
}
}statuserror{
"status": 503,
"error": {
"message": "The server took longer to respond than the maximum allowed processing time.",
"source": "metadata"
}
}