Delete Identifiers

Overview

This API enables you to delete the value of the identifiers that are already associated with users.

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

Endpoint and Headers

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

Headers

Body Parameters

Each DELETE request must have an identifier type, and the value specified in it. You can use either one of the default identifiers which are uuid, email, and phone_number, or any one of the custom identifiers you are using.

Sample Example

Sample Request

Request with default identifiers

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' \
--header 'Cookie: __cfduid=d1a0bc0c8335c7fecbd3485839787329b1615112066' \
--data-raw '{
    "identifiers": {
        "email": "sample@mail.com"
    }
}'

Request with custom identifiers

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' \
--header 'Cookie: __cfduid=d1a0bc0c8335c7fecbd3485839787329b1615112066' \
--data-raw '{
    "identifiers": {
        "custom": {
            "user_loyalty_id": "xyz123"
        }
    }
}'

Sample Responses

• 200 OK
• 400 Bad Request

{
  "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 on the request header. If the token is incorrect, no operation will be executed.
• A single HTTPS DELETE request can pass only 1 record (user).
• Maximum 1,000 requests can be sent per minute.
• Identifier 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.