Update Agreement
PUT {{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}
To update a property value associated with a selected agreement, use the PUT /environments/{{envID}}/agreement/{{agreementID}} endpoint operation to update the agreement resource.
Prerequisites
- See Agreement Management for important overview information.
For property descriptions, see Agreements data model.
| Property | Type | Required? |
|---|---|---|
description | String | Optional |
enabled | Boolean | Required |
name | String | Required |
reconsentPeriodDays | Integer | Optional |
Request Body
{"name"=>"Agreement_1_UPDATED_{{$timestamp}}", "reconsentPeriodDays"=>360}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/43eb5621-eae8-4fa1-aafb-2a884d6848cb"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"43eb5621-eae8-4fa1-aafb-2a884d6848cb","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Agreement_1_UPDATED_1601679632","reconsentPeriodDays":360}