POST 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.
POST/external/accounts/{groupId}/categories
This API call creates a new 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.
Body
- id: The ID of the new tag category.Quinyx will randomly assign the ID upon creating a new tag category.
- name: The name of the new tag category.
- tagType: The tag category type of the new tag category.
- color: The color of the new tag category.
- externalId: The external ID of the new tag category.
Response
- id: The ID of the newly created tag category.
- name: The name of the newly created tag category.
- tagType: The tag category type of the newly created tag category.
- color: The color of the newly created tag category.
- externalId: The external ID of the newly created tag category.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/tags/external/accounts/123/categories
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/accounts/123/categories
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/accounts/123/categories
Body
{
"id": 123,
"name": "exampleTagCategoryName",
"tagType": "EXTENDED",
"color": "#FF5733",
"externalId": "exampleExternalId"
}
"id": 123,
"name": "exampleTagCategoryName",
"tagType": "EXTENDED",
"color": "#FF5733",
"externalId": "exampleExternalId"
}
Response
{
"id": 123,
"name": "exampleTagCategoryName",
"tagType": "EXTENDED",
"color": "#FF5733",
"externalId": "exampleExternalId"
}
"id": 123,
"name": "exampleTagCategoryName",
"tagType": "EXTENDED",
"color": "#FF5733",
"externalId": "exampleExternalId"
}
