Clear Agreed Status on User Agreement

Last modified on August 24, 2023 at 8:19 pm

Overview

Clear the record of a user’s acceptance of an agreement, forcing them to re-agree the next time they log in to DigitalChalk. This is accomplished by PUTting a JSON object with an agreed property set to false to /dc/api/v5/users/{userId}/agreements/{type}. On success, the server will return 204 No Content.

Examples

This example shows clearing acceptance of the agreement for a particular user by sending a JSON object with agreed: false.

Request
PUT /dc/api/v5/users/782ecb882901dfa239247b1cd48a89b2/agreements HTTP/1.1
Host: org.digitalchalk.com
Accept: application/json
Content-Type: application/json

{ "agreed": false }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

References