Delete Identifiers

The Delete User Identities API enables you to delete the value of the identifiers already associated with users.

Take, for example, an existing user known to Insider. This user may have deleted their phone number from your system, so you may need to remove it. With this API, you can delete the value of an existing identifier.

This deletion action cannot be undone. Please carefully consider before proceeding.

Endpoint and Headers

DELETE https://unification.useinsider.com/api/user/v1/identity

Visit our Postman collection to test this request.

Headers

Header	Sample Value	Description
X-PARTNER-NAME	mybrand	This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase.
X-REQUEST-TOKEN	1a2b3c4e5d6f	This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.

Body Parameters

Each DELETE request must include an identifier type and its corresponding value. You can use either one of the default identifiers, which are uuid, email, or phone_number, or any of the custom identifiers you have defined.

If the user is associated with only one identifier, it cannot be deleted.

Parameter	Description	Data Type	Required
identifiers	User’s current identifier in use	Object	Yes
custom	User’s custom identifiers information	Object	No
email	User's email address	String	No
phone_number	User's phone number in E.164 format (e.g. +6598765432)	String	No
uuid	User's unique user identifier	String	No

Sample Request

The sample below displays a request to delete a user’s identity using default identifiers (in this case, an email).

curl --location --request DELETE 'https://unification.useinsider.com/api/user/v1/identity' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4e5d6f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifiers": {
        "email": "sample@useinsider.com"
    }
}'

The sample below displays a request to delete a user’s identity using a custom identifier. Custom identifiers must be passed inside the custom object (e.g., user_loyalty_id).

curl --location --request DELETE 'https://unification.useinsider.com/api/user/v1/identity' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4e5d6f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifiers": {
        "custom": {
            "user_loyalty_id": "xyz123"
        }
    }
}'

Sample Responses

400 Bad Request

Identifiers that are to be deleted cannot be the only identifier associated with a user profile. If you attempt to delete such an identifier, an error message will be displayed as shown below:

{
  "error": "you cannot delete the sole identifier specified for a user: bad request"
}

429 Too Many Requests

If you exceed the rate limits, you receive an error shown below:

{
    "error": "rejected: too many requests"
}

Limitations

All functions must be executed with a simple HTTPS DELETE request.
The request token should be provided in the request header. If the token is incorrect, no operation will be executed.
A single HTTPS DELETE request can pass only 1 record (user).
A maximum of 1,000 requests can be sent per minute.
Identifiers that are to be deleted cannot be the only identifier associated with the corresponding user profile.
The entire request must not exceed 5 MB.
The value of X-PARTNER-NAME header should be lowercase.

The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.