Get the text of the agreement userconsent.agreement.text

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: userconsent

Who can execute the method: any user

The method userconsent.agreement.text returns the text of the agreement.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the agreement.

The identifier can be obtained using the method userconsent.agreement.list

replace
object

Array of replacements for text substitution. Available keys:

  • button_caption — text of the confirmation button
  • fields — list of form fields

The list of available fields is described below

Substitution is performed only for standard agreements created based on templates. For custom agreements with arbitrary HTML text, the parameter is ignored

Parameter fields

Name
type

Description

COMPANY_NAME
text

Company name

COMPANY_ADDRESS
text

Company address

PURPOSES
text

Purpose of data processing

THIRD_PARTIES
text

Third parties to whom data is transferred

EMAIL
string

Email address

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":19,"replace":{"button_caption":"I agree","fields":{"COMPANY_NAME":"Example Ltd.","COMPANY_ADDRESS":"New York, Example St., 1","PURPOSES":"Processing personal data to improve service","THIRD_PARTIES":"Company partners for analytics","EMAIL":"info@example.com"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userconsent.agreement.text
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":19,"replace":{"button_caption":"I agree","fields":{"COMPANY_NAME":"Example Ltd.","COMPANY_ADDRESS":"New York, Example St., 1","PURPOSES":"Processing personal data to improve service","THIRD_PARTIES":"Company partners for analytics","EMAIL":"info@example.com"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userconsent.agreement.text
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AgreementTextResult = {
          LABEL: string
          TEXT: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AgreementTextResult>({
            method: 'userconsent.agreement.text',
            params: {
              id: 19,
              replace: {
                button_caption: 'I agree',
                fields: {
                  COMPANY_NAME: 'Example LLC',
                  COMPANY_ADDRESS: '1 Example St, New York, NY',
                  PURPOSES: 'Processing personal data to improve service',
                  THIRD_PARTIES: 'Company partners for analytics',
                  EMAIL: 'info@example.com',
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Agreement label:', result.LABEL)
            console.info('Agreement text:', result.TEXT)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getAgreementText() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'userconsent.agreement.text',
                params: {
                  id: 19,
                  replace: {
                    button_caption: 'I agree',
                    fields: {
                      COMPANY_NAME: 'Example LLC',
                      COMPANY_ADDRESS: '1 Example St, New York, NY',
                      PURPOSES: 'Processing personal data to improve service',
                      THIRD_PARTIES: 'Company partners for analytics',
                      EMAIL: 'info@example.com',
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Agreement label:', result.LABEL)
              console.info('Agreement text:', result.TEXT)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getAgreementText)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.userconsent.agreement.text(
                bitrix_id=19,
                replace={
                    "button_caption": "I agree",
                    "fields": {
                        "COMPANY_NAME": "Example LLC",
                        "COMPANY_ADDRESS": "1 Example St, New York, NY",
                        "PURPOSES": "Processing personal data to improve service",
                        "THIRD_PARTIES": "Company partners for analytics",
                        "EMAIL": "info@example.com",
                    },
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'userconsent.agreement.text',
                    [
                        'id' => 19,
                        'replace' => [
                            'button_caption' => 'I agree',
                            'fields' => [
                                'COMPANY_NAME' => 'Example Ltd.',
                                'COMPANY_ADDRESS' => 'New York, Example St., 1',
                                'PURPOSES' => 'Processing personal data to improve service',
                                'THIRD_PARTIES' => 'Company partners for analytics',
                                'EMAIL' => 'info@example.com'
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
        'userconsent.agreement.text',
            {
                id: 19,
                replace: {
                    button_caption: "I agree",
                    fields: {
                        COMPANY_NAME: "Example Ltd.",
                        COMPANY_ADDRESS: "New York, Example St., 1",
                        PURPOSES: "Processing personal data to improve service",
                        THIRD_PARTIES: "Company partners for analytics",
                        EMAIL: "info@example.com"
                    }
                }
            },
            function(result) {
                if(result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'userconsent.agreement.text',
            [
                'id' => 19,
                'replace' => [
                    'button_caption' => 'I agree',
                    'fields' => [
                        'COMPANY_NAME' => 'Example Ltd.',
                        'COMPANY_ADDRESS' => 'New York, Example St., 1',
                        'PURPOSES' => 'Processing personal data to improve service',
                        'THIRD_PARTIES' => 'Company partners for analytics',
                        'EMAIL' => 'info@example.com'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "userconsent.agreement.text", b24.Params{
        	"id": 19,
        	"replace": b24.Params{
        		"button_caption": "I agree",
        		"fields": b24.Params{
        			"COMPANY_NAME":    "Example Ltd.",
        			"COMPANY_ADDRESS": "New York, Example St., 1",
        			"PURPOSES":        "Processing personal data to improve service",
        			"THIRD_PARTIES":   "Company partners for analytics",
        			"EMAIL":           "info@example.com",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("userconsent.agreement.text: %w", err)
        }
        
        var item struct {
        	Label string `json:"LABEL"`
        	Text  string `json:"TEXT"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Label, item.Text)
        

Response Handling

HTTP Status: 200

{
        "result": {
            "LABEL": "By clicking the 'I agree' button, I consent to the processing of my personal data in accordance with Federal Law No. 152-FZ of July 27, 2006 'On Personal Data', under the conditions and for the purposes defined in the Consent to the processing of personal data",
            "TEXT": "Consent to the processing of personal data\n\nHereby, in accordance with Federal Law No. 152-FZ 'On Personal Data' of July 27, 2006, I freely, of my own will and in my interest express my unconditional consent to the processing of my personal data, registered in accordance with the legislation of the USA at the address: \n (hereinafter referred to as the Operator).\n1. Consent is given for the processing of one, several, or all categories of personal data, which are not special or biometric, provided by me, which may include:\n\n- Example Ltd.;\n- New York, Example St., 1;\n- Processing personal data to improve service;\n- Company partners for analytics;\n- info@example.com.\n\n2. The Operator may perform the following actions: collection; recording; systematization; accumulation; storage; clarification (updating, modification); extraction; use; blocking; deletion; destruction. \n\n3. Methods of processing: both using automation tools and without their use.\n\n4. Purpose of processing: providing me with services/work, including sending notifications regarding the services/work provided, preparing and sending responses to my requests, sending me information about events/products/services/work of the Operator.\n\n5. Since the Operator may process my personal data using the software 'QuickBooks and other similar platforms', I give my consent to the Operator to carry out the corresponding assignment to Example Ltd., (OGRN 5077746476209), registered at the address: 109544, New York, Enthusiast Blvd., 2, floor 13, room 8-19.\n\n6. This consent is valid until revoked by sending a corresponding notification to the email address test@example.com or by sending it to the address.\n\n7. In case I revoke my consent to the processing of personal data, the Operator has the right to continue processing personal data without my consent if there are grounds provided by Federal Law No. 152-FZ 'On Personal Data' of July 27, 2006."
        },
        "time": {
            "start": 1760611223,
            "finish": 1760611223.240694,
            "duration": 0.2406940460205078,
            "processing": 0,
            "date_start": "2025-10-16T13:40:23+02:00",
            "date_finish": "2025-10-16T13:40:23+02:00",
            "operating_reset_at": 1760611823,
            "operating": 0
        }
        }
        

Returned Data

Name
type

Description

result
array

Root element of the response

LABEL
string

Title of the agreement

TEXT
string

Text of the agreement

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error":"400",
            "error_description":"Parameter `Agreement ID` required."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

ERROR_ARGUMENT

Parameter Agreement ID required

Parameter id not provided

400

ERROR_ARGUMENT

Agreement with id 999 not found

Agreement with the specified id not found

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning