Add and Remove Tags from a Customer

Use these API endpoint to add or remove tags to a customer record for a specified subcompany. Provide the subcompany ID and the customer's unique ID in the URL path. The tags to be added or removed should be included in the JSON body of the appropriate API, and the takeover secret must be included in the header.

Add Customer Tags

PUThttps://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/add-tags

Path parameters

subcompany_id*Subcompany Id

provided_unique_id*Provided Unique Id

Header parameters

Body

application/json

tags*Tags

Response

200404422

Successful Response

Body

application/json

successSuccess

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/add-tags', {
    method: 'PUT',
    headers: {
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tags": [
        {
          "tag": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200422

{
  "success": true
}

Remove Customer Tags

PUThttps://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/remove-tags

Path parameters

subcompany_id*Subcompany Id

provided_unique_id*Provided Unique Id

Header parameters

Body

application/json

idsIds

tagsTags

Response

200404422

Successful Response

Body

application/json

successSuccess

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/remove-tags', {
    method: 'PUT',
    headers: {
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200422

{
  "success": true
}