DELETE /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
Deletes a relationship between two entities (user, space, content).
Permissions required: Permission to access the Confluence site ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite relationships. A space administrator can delete favourite relationships for any user.
Servers
- https://your-domain.atlassian.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
targetKey |
String | Yes |
|
targetType |
String | Yes |
The target entity type of the relationship. This must be 'space' or
'content', if the Possible values:
|
sourceType |
String | Yes |
The source entity type of the relationship. This must be 'user', if
the Possible values:
|
sourceKey |
String | Yes |
|
relationName |
String | Yes |
The name of the relationship. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
targetVersion |
Integer | No |
The version of the target. This parameter is only used when the
|
targetStatus |
String | No |
The status of the target. This parameter is only used when the
|
sourceVersion |
Integer | No |
The version of the source. This parameter is only used when the
|
sourceStatus |
String | No |
The status of the source. This parameter is only used when the
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.