DELETE data

Updated by Victor Jespersen

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.

DELETE/groups/{collaborationGroupId}

This API call deletes collaboration groups together with it's child collaboration groups.

Field description

Mandatory fields will be marked with a * icon.

Endpoint
  • collaborationGroupId*: The ID of the collaboration group you want to delete.
Body

This API call has no-body.

Response

This API call has no response.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123

DELETE/delete-groups

This API call removes groups associated with a collaboration group.

Field description

Mandatory fields will be marked with a * icon.

Endpoint

This API call has no fields in the endpoint.

Body
  • collaborationGroupId: The ID of the collaboration group from which you want to remove associated groups.
  • groupIds: The IDs of the groups you want to remove from the collaboration group.
Response

This API call has no response.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/delete-groups
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/delete-groups
Body
{
"collaborationGroupId": 0,
"groupIds": [0]
}

DELETE/delete-employees

This API call removes employees associated with a collaboration group.

Field description

Mandatory fields will be marked with a * icon.

Endpoint

This API call has no fields in the endpoint.

Body
  • collaborationGroupId: The ID of the collaboration group from which you want to remove associated employees.
  • employeeIds: The IDs of the employees you want to remove from the collaboration group.
Response

This API call has no response.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/delete-employees
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/delete-employees
Body
{
"collaborationGroupId": 0,
"employeeIds": [0]
}


How Did We Do?