Page Comparison

...

Excerpt
Withdraw a permission for an entity

Endpoint ID:

2109

2107

Method:

Status

colour	Green
title	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-key

External key that uniquely identifies the entity

ext-type

Type of external key

permissionID

A GUID string identifier for the permission

Request body:

JSON data describing the permission withdrawal

Required fields

sourceID

The

ID

GUID string identifier of the withdrawal source
	reason	A reason for the withdrawal
Optional fields
	termsID	The 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.

Code Block
{ "sourceID":

234

"26f2da92-c9ca-4a82-90f0-8a8a43534239",
    "reason": "Abc",
    "termsID": "8f87ade0-c5a2-4031-89b9-33c923c4588e"
}

Span

style	white-space:nowrap

Response body:

None

Status codes:

204

The permission was withdrawn

404

The entity or permission were not found.

The following sub codes may be returned:

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

412

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

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

Versions Compared