Удалить пользовательское поле лидов crm.lead.userfield.delete

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: администратор CRM

Метод crm.lead.userfield.delete удаляет пользовательское поле лидов.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

Идентификатор можно получить с помощью методов crm.lead.userfield.add или crm.lead.userfield.list

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":432}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.userfield.delete
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":432,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.userfield.delete
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.lead.userfield.delete',
        		{
        			id: 432,
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $userfieldId = 123; // Replace with the actual userfield ID you want to delete
            $result = $serviceBuilder
                ->getCRMScope()`r`n            ->leadUserfield()
                ->delete($userfieldId);
        
            if ($result->isSuccess()) {
                print("Userfield deleted successfully.");
            } else {
                print("Failed to delete userfield.");
            }
        } catch (Throwable $e) {
            print("An error occurred: " . $e->getMessage());
        }
        
BX24.callMethod(
            'crm.lead.userfield.delete',
            {
                id: 432,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.userfield.delete',
            [
                'id' => 432
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1724419843.518672,
                "finish": 1724419844.120328,
                "duration": 0.6016559600830078,
                "processing": 0.1907808780670166,
                "date_start": "2024-08-23T15:30:43+02:00",
                "date_finish": "2024-08-23T15:30:44+02:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
boolean

Корневой элемент ответа, содержит true в случае успеха

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

400

ID is not defined or invalid

Переданный id либо меньше или равен нулю, либо же не передан вовсе

403

Access denied

Возникает в случаях, когда:

  • у пользователя нет административных прав
  • пользователь пытается удалить пользовательское поле, не привязанное к лидам

ERROR_NOT_FOUND

The entity with ID 'id' is not found

Пользовательское поле с переданным id не существует

400

Ошибка удаления FIELD_NAME для объекта ENTITY_ID

Неизвестная ошибка при удалении

Продолжите изучение