Delete Identity Link

Removes an identity link from a task.

Method

POST /task/{id}/identity-links/delete

Parameters

Path Parameters

Name Description
id The id of the task to remove a link from.

Request Body

A JSON object with the following properties:

Name Description
userId The id of the user being part of the link. If you set this parameter, you have to omit groupId.
groupId The id of the group being part of the link. If you set this parameter, you have to omit userId.
type Specifies the type of the link. Must be provided.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Task with given id does not exist. See the Introduction for the error response format.

Example

Request

POST /task/anId/identityLinks/delete

Request body:

{"groupId": "theOldGroupId", "type": "candidate"}

Response

Status 204. No content.

On this Page: