Note: Custom Tag APIs are not available for trial users. A subscription is required to access these features. Please contact help@protecto.ai for assistance.
This endpoint allows users to add or update a custom PII tag.(eg- Customter Id), and configure Identification Endpoint details.
Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token
Route: /metadata/add-or-update/custom-tag/identification-endpoint.
Request Type: PUT.
Input Structure:
- The input structure consists of a JSON object with a
datafield containing:tag_type: The type of the custom tag.identification_endpoint_details: Details of the identification endpoint including URL, method, and headers(if applicable)- policy_name:Name of the Policy.(Prerequisite: Create the Policy )
{
"data":{
"policy_name":"Testing_Default_Policy"
"tag_type":"CUSTOMER_ID",
"identification_endpoint_details":{
"url":"<url>",
"method":"PUT",
"headers":{
"Authorization":"Bearer <access_token>"
}
}
}
}
Response:
Upon successful addition or update, the response contains a JSON object with:
- A
datafield containing a success message indicating that the custom PII tag has been added or updated successfully.
{
"data":{
"message":"custom tag CUSTOMER_ID added or updated successfully."
},
"success":"true",
"error":{
"message":""
}
}