Delete User Attribute

Overview

This API enables you to delete your customer attribute when you need to. You can either delete the whole attribute from the user, or delete a specific value from an array typed attribute. 

For example, your customer might have selected GDPR’s “right-to-be-forgotten” option and you need to delete some attributes that capture such customer information.

Endpoint and Headers

POST https://unification.useinsider.com/api/user/v1/attribute/delete

Headers

Body Parameters

Each POST body must have a unifier field under identifiers object, which is decided by customer. You can use the default identifiers such as email, phone number, or uuid and also the custom identifier to define a unifier.

Sample Example

Sample Request

curl --location --request POST 'https://unification.useinsider.com/api/user/v1/attribute/delete' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "users": [
        {
            "identifiers": {
                "email": "sample@mail.com",
                "uuid": "1x2y3z",
                "custom": {
                    "custom_identifier": "xyz123"
                }
            },
            "whole": [
                "name",
                "surname",
                "email_optin"
            ],
            "partial": {
                "list_id": [
                    1,
                    2
                ]
            },
            "custom": {
                "whole": [
                    "custom_string_attribute",
                    "custom_array_attribute"
                ],
                "partial": {
                    "custom_array_attribute": [
                        "value1",
                        "value2",
                        "value3"
                    ]
                }
            }
        }
    ]
}'

The sample below displays a request to get user data with insider_id.

curl --location --request POST 'https://unification.useinsider.com/api/user/v1/attribute/delete' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
  "users": [
    {
      "insider_id": "sampleinsiderid",
      "whole": [
        "name",
        "surname",
        "email_optin"
      ],
      "partial": {
        "list_id": [
          1,
          2
        ]
      },
      "custom": {
        "whole": [
          "custom_string_attribute",
          "custom_array_attribute"
        ],
        "partial": {
          "custom_array_attribute": [
            "value1",
            "value2",
            "value3"
          ]
        }
      }
    }
  ]
}'

Sample Responses

200 OK

{}

400 Bad Request

{
    "success": false,
    "message": "Partner is invalid."
}

403 Forbidden

{
    "success": false,
    "message": "Access Denied. You do not have sufficient access to perform this action."
}

429 Too Many Requests

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

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

500 Internal Server Error

{
    "success": false,
    "message": "The request processing has failed because of an unknown error."
}

Limitations

• All functions must be executed with a simple HTTPS POST request.
• Only delete requests can be sent via this API. No data can be retrieved.
• The request token should be provided on the request header. If the token is incorrect, the operation will not be executed.
• A single HTTPS POST request can pass only 1,000 records (users).
• Rate limit is shared with User Upsert API with a total of 25,000 requests per minute.
• The entire request must not exceed 5 MB.
• The value of X-PARTNER-NAME header should be lowercase.