Skip to main content

Add Tags to User Form

Endpoint: PUT /api/human/template/{name}/tags

Adds tags to a user form. You can add a single tag or multiple tags in one request. If a tag with the same key already exists, this operation will update its value.

Path parameters

ParameterDescriptionTypeRequired/ Optional
nameThe name of the user form to which the tags are to be added.stringRequired.

Request body

The request body should be an array of tag objects.

ParameterDescriptionTypeRequired/ Optional
keyThe tag key.stringRequired.
valueThe tag value.stringRequired.

Example for adding multiple tags in a single request:

[
{
"key": "dev",
"value": "automation"
},
{
"key": "backend",
"value": "PR"
}
]

Response

Returns 200 OK, indicating that tags have been added to the user form.

Examples

Add a single tag to a user form

Request

curl -X 'PUT' \
'https://<YOUR-SERVER-URL>/api/human/template/EmployeeOnboarding/tags' \
-H 'accept: */*' \
-H 'X-Authorization: <TOKEN>' \
-H 'Content-Type: application/json' \
-d '[
{
"key": "prod",
"value": "env"
}
]'

Response

Returns 200 OK, indicating that the tag has been added to the user form.

Add multiple tags to a user form

Request

curl -X 'PUT' \
'https://<YOUR-SERVER-URL>/api/human/template/EmployeeOnboarding/tags' \
-H 'accept: */*' \
-H 'X-Authorization: <TOKEN>' \
-H 'Content-Type: application/json' \
-d '[
{
"key": "dev",
"value": "automation"
},
{
"key": "backend",
"value": "PR"
}
]
'

Response

Returns 200 OK, indicating that tags have been added to the user form.