Agreement languages define the configuration for the locale and for the configuration that applies to all revision resources associated with the language.

Agreement languages are defined by either the language code (for example, en) or the combination of language code and country code (for example, en-gb). For identifying languages, the API follows the tags for identifying languages described in RFC_4646. For selecting a language code to use in an agreement, the API follows the matching of language tags described in RFC_4647.

The end user’s language selection for the consent agreement is determined by these attributes in the following priority: (1) the user’s preferred locale, (2) the browser locale, or (3) the default language for the environment.

The agreement languages service implements functions to create, read, update, and delete agreement language resources.

Agreement languages data model

Property Description
agreement A relationship that specifies the agreement resource associated with this language resource. This is a required property.
currentRevision A relationship that specifies the current revision associated with this language resource. The current revision is the one shown to users for new consents in the language.
displayName A string that is used as the title of the agreement for the language presented to the user. This is a required property.
enabled A date that maps directly with a language being enabled or displayed for the environment within the platform. This is a required property.
id A string that specifies the language ID.
locale A string that specifies the tag for identifying the language resource associated with this agreement consent (for example, en-US). This is a required property. For more information about language tags, see Tags for Identifying Languages.
userExperience.acceptCheckboxText A string that specifies the text next to the “accept” checkbox in the end user interface. Accepted character are unicode letters, combining marks, numeric characters, whitespace, and punctuation characters (regex: ^[\p{L}\p{M}\p{N}\p{Zs}\p{P}]+$).
userExperience.continueButtonText A string that specifies the text of the “continue” button in the end user interface. Accepted character are unicode letters, combining marks, numeric characters, whitespace, and punctuation characters (regex: ^[\p{L}\p{M}\p{N}\p{Zs}\p{P}]+$).
userExperience.declineButtonText A string that specifies the text of the “decline” button in the end user interface. Accepted character are unicode letters, combining marks, numeric characters, whitespace, and punctuation characters (regex: ^[\p{L}\p{M}\p{N}\p{Zs}\p{P}]+$).

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request.
404 The requested resource was not found.