2107: Withdraw permission

Owned by Nick Jensen
Last updated: Apr 26, 2018Version comment
1 min read

Withdraw a permission for an entity

Endpoint ID:2107
Method:

PUT

URL:

/permissions/entity/id/{entityID}/permission/{permissionID}/withdraw

/permissions/entity/ext-key/{ext-key}/{ext-type}/permission/{permissionID}/withdraw


entityID

dialogportalâ„¢ master key that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

permissionIDA GUID string identifier for the permission
Request body:

JSON data describing the permission withdrawal

Required fields

sourceIDThe GUID string identifier of the withdrawal source

reasonA reason for the withdrawal
Optional fields

termsIDThe GUID string identifier of the terms this permission is being withdrawn from. When a termsID is included, then this endpoint is only used to withdraw a permission for an existing terms acceptance.
{
    "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239",
    "reason": "Abc",
    "termsID": "8f87ade0-c5a2-4031-89b9-33c923c4588e"
}

Response body:

None
Status codes:204The permission was withdrawn

404

The entity or permission were not found.

The following sub codes may be returned:

404.1Entity not found
404.2External entity reference could not be found
404.5Permission not found
404.6Source not found

412

The contract does not allow access to this permission, or allow this withdrawal source

412.2The permission is not allowed
412.3The source is not allowed