Skip to main content

Update Tag For Company

Este endpoint sirve para actualizar las definiciones de tags de una compañia específica, elegida por la variable de ruta company_id. Cuando se entrega la respuesta, se muestran todas las definiciones de tags presentes en la aplicación.

Endpoint

Headers

KeyValueDescription
Content-Typeapplication/json
AuthorizationBearer {{access_token}}access_token obtained in Atenea
Method: PUT
URL: https://api.trust.lat/index/v1/company/:company_id/tags

Path Variables:

KeyValue ExampleDescription
company_id99Identificador 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

Como obtener un access token

Body

Fields

  • tag_name: Campo que indica el nombre con el cual se identifica el tag. Obligatorio.
  • description: Texto que permite detallar el próposito y/o uso del tag. Opcional.
  • color: Código RGB hexadecimal utilizado para identificar el tag en un entorno web. Opcional.

Example

{
"tag_name": "department",
"description": "Internal division for work assignments",
"color": "#AFAFAF"
}

Code Examples

curl --location --request PUT 'https://api.trust.lat/index/v1/company/99/tags' \
--header 'Authorization: Bearer ************' \
--header 'Content-Type: application/json' \
--data-raw '{
"tag_name": "department",
"description" : "Internal division for work assignments",
"color": "#FAFAFA"
}'

Responses

HTTP Code: 200 OK

Tag for company updated

{
"code": 200,
"resource": "AppTags",
"data": {
"company_uid": "99",
"created_at": "2021-05-11T14:24:03.826Z",
"tags": [
{
"color": "#795548",
"deleted_at": null,
"description": "placeholder",
"name": "systemic_sub_company",
"updated_at": null,
"values": []
},
{
"color": "#1234212",
"deleted_at": null,
"description": "default",
"name": "este_no_es_un_tag2.0",
"updated_at": "2021-07-05T20:58:29.634Z",
"values": []
},
{
"color": "#1234212",
"deleted_at": null,
"description": "default",
"name": "tag_trust_test",
"updated_at": "2021-07-05T22:34:28.232Z",
"values": []
},
{
"color": "#1234212",
"deleted_at": null,
"description": "default",
"name": "tag_trust_test2",
"updated_at": "2021-07-06T17:00:12.980Z",
"values": []
},
{
"color": "#2E4990",
"deleted_at": null,
"description": "esta no es una descripcion 3",
"name": "tag_trust_test3",
"updated_at": "2021-07-06T17:32:36.541Z",
"values": []
}
],
"updated_at": "2021-05-11T14:24:03.826Z"
},
"message": "Updated"
}

HTTP Code: 404 Not Found

Company not present in Trust Services

{
"code": 404,
"resource": "AppTags",
"message": "Not found"
}

HTTP Code: 422 Unprocessable Entity

Tag not present in company

{
"code": 422,
"resource": "AppTags",
"message": "Fail",
"errors": {
"tags": [
"Tag 'section' not found in Tags"
]
}
}