Create Language
POST {{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages
The POST /environments/{{envID}}/agreements/{{agreementID}}/languages
endpoint creates a new languages resource in the specified environment.
The request body must include values for the displayName
, locale
, agreement
, and enabled
properties.
Prerequisites
See Agreement Management for important overview information.
Create an agreement to get an
agreementID
. See Create Agreement.
For property descriptions, see Agreement languages data model.
Property | Type | Required? |
---|---|---|
displayName | String | Required |
enabled | Date | Required/Optional |
locale | String | Required |
userExperience.acceptCheckboxText | String | Optional |
userExperience.continueButtonText | String | Optional |
userExperience.declineButtonText | String | Optional |
Request Body
{"locale"=>"en-US", "displayName"=>"Language_1", "enabled"=>true}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/43eb5621-eae8-4fa1-aafb-2a884d6848cb/languages/a00abf13-22fc-4d66-a89e-7f6abb1d323f"},"agreement":{"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":"a00abf13-22fc-4d66-a89e-7f6abb1d323f","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"displayName":"Language_1","agreement":{"id":"43eb5621-eae8-4fa1-aafb-2a884d6848cb"},"enabled":true,"locale":"en-US"}