Delete Tags Of Person By Company
Endpoint que permite eliminar uno o más tags a una persona perteneciente a una compañia específica, dada por la variable de ruta company_id. Para identificar a la persona, es necesario incorporar por lo menos uno de los siguientes campos en la request [email|dni].
Endpoint
Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Method: DELETE
URL: https://api.trust.lat/index/v1/company/:company_id/persons/tags
Path Variables:
Key | Value Example | Description |
---|---|---|
company_id | 99 | Identificador de compañia provisto por empresa Trust. Obligatorio. |
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea
Body
Fields
- email: Correo de la persona. Parcialmente Obligatorio.
- dni: Identificador nacional de una persona. Parcialmente Obligatorio.
- tags: Arreglo conteniendo los nombres de los tags sistémicos a eliminar. Obligatorio (Por lo menos un valor).
Example
{
"email": "abeta@example.test",
"dni": "12345678-9",
"tags": [
"systemic-sub-company"
]
}
Conceptual Example
Borrar el tag "systemic_sub_company" a la persona "Juan"
Antes del cambio
systemic_sub_company | deparment | |
---|---|---|
pepe | bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb | backend |
juan | dddddddd-dddd-dddd-dddd-dddddddddddd |
Despues del cambio
systemic_sub_company | deparment | |
---|---|---|
pepe | bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb | backend |
juan | mobile |
Code Examples
- Curl
- JavaScript
- Python
curl --location --request DELETE 'https://api.trust.lat/index/v1/company/99/persons/tags' \
--header 'Authorization: Bearer ************' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "abeta@example.test",
"dni": "12345678-9",
"tags": [
"systemic-sub-company"
]
}'
import requests
url = "https://api.trust.lat/index/v1/company/99/persons/tags"
payload="{\n \"email\": \"abeta@example.test\",\n \"dni\": \"12345678-9\",\n \"tags\": [\n \"systemic-sub-company\"\n ]\n}"
headers = {
'Authorization': 'Bearer ************',
'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var data = JSON.stringify({"email":"abeta@example.test","dni":"12345678-9","tags":["systemic-sub-company"]});
var config = {
method: 'delete',
url: 'https://api.trust.lat/index/v1/company/99/persons/tags',
headers: {
'Authorization': 'Bearer ************',
'Content-Type': 'application/json'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Responses
HTTP Code: 200 OK
Tag deleted successfully
HTTP Code: 404 Not Found
Missing person fields