PUT Data
Updated
by
Victor Jespersen
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “tags” definition)
Api-docs: https://api.quinyx.com/v2/docs (select “tags” definition)
Base URL can be found on links above for both environments. The remainder of this article should be considered a complement to the above Open API documentation.
PUT/external/accounts/{groupId}/categories/{categoryId}
This API call updates an existing tag category.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The ID of the Quinyx group from which you want to fetch the tag category information.
- categoryId*: The tag category ID of the tag category you wish to update.
Body
- id: The ID of the tag category.
- name: The new name of the tag category.
- tagType: The new tag category type.
- color: The new color of the tag category.
- externalId: The new external ID of the tag category.
Response
- id: The ID of the tag category.
- name: The updated name of the tag category.
- tagType: The updated tag category type.
- color: The updated color of the tag category.
- externalId: The updated external ID of the tag category.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/tags/external/accounts/123/categories/321
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/accounts/123/categories/321
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/accounts/123/categories/321
Body
{
"id": 123,
"name": "exampleCategoryName",
"tagType": "PROJECT",
"color": "#FFFFFF",
"externalId": "exampleExternalID"
}
"id": 123,
"name": "exampleCategoryName",
"tagType": "PROJECT",
"color": "#FFFFFF",
"externalId": "exampleExternalID"
}
Response
{
"id": 123,
"name": "exampleCategoryName",
"tagType": "PROJECT",
"color": "#FFFFFF",
"externalId": "exampleExternalID"
}
"id": 123,
"name": "exampleCategoryName",
"tagType": "PROJECT",
"color": "#FFFFFF",
"externalId": "exampleExternalID"
}
