2110: Update terms acceptance

2110: Update terms acceptance

Update the permissions/consents for a terms acceptance

Endpoint ID:

2110

Method:

PUT

URL:

/permissions/entity/id/{entityID}/terms/{termsID}

/permissions/entity/ext-key/{ext-key}/{ext-type}/terms/{termsID}

 

entityID

dialogportal™ master key that uniquely identifies the entity

 

ext-key

External key that uniquely identifies the entity

 

ext-type

Type of external key

 

termsID

A GUID string identifier for the terms

JSON data describing updated terms consents

Required fields



sourceID

The GUID string identifier of the acceptance/withdrawal source



consents

An array of consentIDs which represent which terms consents have been accepted. Any previously accepted terms consents not included in this list are withdrawn, and any previously not accepted terms consents which are in the list are accepted.



withdrawReason

If any previously accepted consents are not included in consents and are therefore withdrawn, this withdrawReason will be recorded for the withdrawn consent.

 

{ "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239", "consents": [ "5d9d6071-2158-40f4-b1b7-c101bffc518e" ], "withdrawReason": "Abc" }

Response body:

None

Status codes:

204

Terms consents were updated

 

400

Terms consents could not be updated.

The following subcodes may be returned:

400.3

Source not active

 

404

The entity or terms were not found.

The following subcodes may be returned:

404.1

Entity not found

404.2

External entity reference could not be found

404.4

Terms not found

404.6

Source not found

 

412

The contract or terms do not allow access:

412.1

The terms are not allowed for this contract

412.3

The source is not allowed for this contract

412.6

The entity type is not allowed for this terms version