метод REST scope: userconsent

userconsent.consent.add

Сохранить полученное согласие пользователя

Кто может выполнять: любой пользователь

Описание

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

Параметры

AGREEMENT_ID integer обязательный

Идентификатор соглашения.

Идентификатор можно получить с помощью метода userconsent.agreement.list

IP string обязательный

IP-адрес пользователя

USER_ID integer необязательный

Идентификатор пользователя.

Идентификатор можно получить с помощью методов user.get и user.search

URL string необязательный

URL страницы, где было получено согласие

ORIGIN_ID string необязательный

Идентификатор источника, например, my_contact_form

ORIGINATOR_ID string необязательный

Идентификатор элемента в источнике, например, e-mail

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

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

Ответ

HTTP-статус: 200

{
"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

{
    "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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.