# userconsent.consent.add

URL: https://chugunov.pro/api-bitrix24/user-consent/user-consent-consent-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Сохранить полученное согласие пользователя
Scope: `userconsent`
Кто может выполнять метод: любой пользователь

## Описание

Метод `userconsent.consent.add` сохраняет полученное согласие пользователя.

## Параметры

- `AGREEMENT_ID` `integer` — обязательный. Идентификатор соглашения.
  Идентификатор можно получить с помощью метода [userconsent.agreement.list](https://chugunov.pro/api-bitrix24/user-consent/user-consent-agreement-list/)
- `IP` `string` — обязательный. IP-адрес пользователя
- `USER_ID` `integer` — необязательный. Идентификатор пользователя.
  Идентификатор можно получить с помощью методов [user.get](https://chugunov.pro/api-bitrix24/user/user-get/) и [user.search](https://chugunov.pro/api-bitrix24/user/user-search/)
- `URL` `string` — необязательный. URL страницы, где было получено согласие
- `ORIGIN_ID` `string` — необязательный. Идентификатор источника, например,  `my_contact_form`
- `ORIGINATOR_ID` `string` — необязательный. Идентификатор элемента в источнике, например, e-mail

## Ответ

HTTP-статус: 200

```json
{
"result": 525,
"time": {
    "start": 1760459630,
    "finish": 1760459630.700988,
    "duration": 0.7009880542755127,
    "processing": 0,
    "date_start": "2025-10-14T19:33:50+03:00",
    "date_finish": "2025-10-14T19:33:50+03:00",
    "operating_reset_at": 1760460230,
    "operating": 0
}
}
```

### Возвращаемые данные

- `result` `integer`. Идентификатор добавленного согласия
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

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

- `400` — `ERROR_ARGUMENT`. Parameter `Agreement ID` required
- `400` — `ERROR_ARGUMENT`. Agreement with id `999` not found
- `400` — `ERROR_ARGUMENT`. —

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"AGREEMENT_ID":19,"USER_ID":123,"IP":"192.168.1.100","URL":"https://example.com/contact-form","ORIGIN_ID":"my_contact_form","ORIGINATOR_ID":"user@example.com"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userconsent.consent.add
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"AGREEMENT_ID":19,"USER_ID":123,"IP":"192.168.1.100","URL":"https://example.com/contact-form","ORIGIN_ID":"my_contact_form","ORIGINATOR_ID":"user@example.com","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/userconsent.consent.add
```

### JS (TS)

```ts
// 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

try {
  const response = await $b24.actions.v2.call.make<number>({
    method: 'userconsent.consent.add',
    params: {
      AGREEMENT_ID: 19,
      USER_ID: 123,
      IP: '192.168.1.100',
      URL: 'https://example.com/contact-form',
      ORIGIN_ID: 'my_contact_form',
      ORIGINATOR_ID: 'user@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('Created consent with ID:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 addConsent() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'userconsent.consent.add',
        params: {
          AGREEMENT_ID: 19,
          USER_ID: 123,
          IP: '192.168.1.100',
          URL: 'https://example.com/contact-form',
          ORIGIN_ID: 'my_contact_form',
          ORIGINATOR_ID: 'user@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('Created consent with ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addConsent)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.userconsent.consent.add(
        agreement_id=19,
        user_id=123,
        ip="192.168.1.100",
        url="https://example.com/contact-form",
        origin_id="my_contact_form",
        originator_id="user@example.com",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'userconsent.consent.add',
            [
                'AGREEMENT_ID' => 19,
                'USER_ID' => 123,
                'IP' => '192.168.1.100',
                'URL' => 'https://example.com/contact-form',
                'ORIGIN_ID' => 'my_contact_form',
                'ORIGINATOR_ID' => 'user@example.com'
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding consent: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
'userconsent.consent.add',
{
    AGREEMENT_ID: 19,
    USER_ID: 123,
    IP: "192.168.1.100",
    URL: "https://example.com/contact-form",
    ORIGIN_ID: "my_contact_form",
    ORIGINATOR_ID: "user@example.com"
},
function(result) {
    if (result.error()) {
    console.error(result.error());
    } else {
    console.log(result.data());
    }
}
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'userconsent.consent.add',
    [
        'AGREEMENT_ID' => 19,
        'USER_ID' => 123,
        'IP' => '192.168.1.100',
        'URL' => 'https://example.com/contact-form',
        'ORIGIN_ID' => 'my_contact_form',
        'ORIGINATOR_ID' => 'user@example.com'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "userconsent.consent.add", b24.Params{
	"AGREEMENT_ID":  19,
	"USER_ID":       123,
	"IP":            "192.168.1.100",
	"URL":           "https://example.com/contact-form",
	"ORIGIN_ID":     "my_contact_form",
	"ORIGINATOR_ID": "user@example.com",
})
if err != nil {
	return fmt.Errorf("userconsent.consent.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/user-consent/user-consent-consent-add.html