User Agreements: Overview of Methods

In Bitrix24, you can create user agreements. They are necessary if you process personal data, send newsletters, or perform other actions that require user consent.

With the REST API, you can:

• retrieve lists of agreements
• upload agreement texts
• save obtained consents

Agreements should be created and modified through the Bitrix24 interface.

Quick navigation: all methods

Types of AgreementsTypes of Agreements

There are two types of agreements in Bitrix24: standard and custom.

• Standard agreements are created from pre-installed templates. They support localization and variable replacement through the replace parameter in the userconsent.agreement.text method.

• Custom agreements are created manually. They contain arbitrary HTML text and do not support variable substitution.

Connection with Other ObjectsConnection with Other Objects

Users. Consents can be linked to users through the USER_ID parameter. To obtain the user ID, use the user.get and user.search methods.

Overview of MethodsOverview of Methods

Scope: userconsent

Who can execute the method: any user

Method	Description
userconsent.agreement.list	Retrieves a list of agreements
userconsent.agreement.text	Retrieves the text of an agreement
userconsent.consent.add	Saves the obtained user consent