POST data
Updated
by
Daniel Sjögren
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select "collaboration-groups" definition)
Api-docs: https://api.quinyx.com/v2/docs (select "collaboration-groups" 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/labels
This API call will create a label for a domain.
Field description
Mandatory fields will be marked with an asterisk*.
Endpoint
This API call has no fields in the endpoint.
Body
- name*: The name of the label you wish to create for a domain.
- domainId*: The Quinyx customer ID. This is found in the URL in the the web portal by going to Account settings > Organization > Select the domain at the top of the organization hierarchy.
- color: The color of the label you wish to create.
Response
- id: Displays the ID of the label you have created.
- name: Displays the name of the label you have created.
- color: Displays the assigned color of the label you have created.
- domainId: Displays the Quinyx customer ID that the label you created belongs to.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/labels
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/labels
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/labels
Request body
Example value
{
"name": "District North",
"domainId": 123,
"color": "blue"
}
{
"name": "District North",
"domainId": 123,
"color": "blue"
}
Responses
Example value
{
"id"; 1575
"name": "District North",
"color": "blue",
"domainId": 123
}
{
"id"; 1575
"name": "District North",
"color": "blue",
"domainId": 123
}
Read more about our REST documentation here.
