Create Tag For Company

Este endpoint sirve para definir tags asociados a una compañia específica, elegida por la variable de ruta company_id. Estas definiciones son necesarias para el uso del servicio tags en personas, dado que para asignar un valor a un tag, primero se revisa que la definición de ese tag se encuentre en la aplicación. Cuando se entrega la respuesta, se muestran todas las definiciones de tags presentes en la compañia.

Endpoint#

Headers

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {{access_token}}	access_token obtained in Atenea

Method: POST
URL: https://api.trust.lat/index/v1/company/:company_id/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

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. Obligatorio.
color: Código RGB hexadecimal utilizado para identificar el tag en un entorno web. Obligatorio.

Example#

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

Code Examples#

Curl
JavaScript
Python

curl --location --request POST '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": "#AFAFAF"
}'

Responses#

HTTP Code: 201 Created#

Tag for company created successfully#

{
    "code": 201,
    "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": []
            }
        ],
        "updated_at": "2021-05-11T14:24:03.826Z"
    },
    "message": "Created"
}

HTTP Code: 422 Unprocessable Entity#

Tag already present in company#

{
    "code": 422,
    "resource": "AppTags",
    "message": "Fail",
    "errors": {
        "tags": [
            "duplicated tag name"
        ]
    }
}

Missing tags fields#

{
    "code": 422,
    "resource": "AppTags",
    "message": "Fail",
    "errors": {
        "tags": [
            "is invalid"
        ]
    }
}