crm-requisite-userfield-delete.md

Delete User Field of Requisite crm.requisite.userfield.delete

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Scope: crm

Who can execute the method: administrator, user with the "Allow to modify settings" access permission in CRM

Deletes a custom field of the company details.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* integer | Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":235}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.delete

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":235,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.delete

• JS (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<boolean>({
      method: 'crm.requisite.userfield.delete',
      params: {
        id: 235,
      },
      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('User field deleted:', result)
    }
  } catch (error) {
    // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
    console.error(error)
  }

• JS (UMD)

  <!-- 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 deleteRequisiteUserField() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'crm.requisite.userfield.delete',
          params: {
            id: 235,
          },
          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('User field deleted:', result)
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', deleteRequisiteUserField)
  </script>

• PHP

  try {
      $response = $b24Service
          ->core
          ->call(
              'crm.requisite.userfield.delete',
              [
                  'id' => 235,
              ]
          );
  
      $result = $response
          ->getResponseData()
          ->getResult();
  
      if ($result->error()) {
          error_log($result->error());
      } else {
          echo 'Success: ' . print_r($result->data(), true);
      }
  
  } catch (Throwable $e) {
      error_log($e->getMessage());
      echo 'Error deleting user field: ' . $e->getMessage();
  }

• Python

  Example

  from b24pysdk.client import BaseClient
  from b24pysdk.errors import BitrixAPIError, BitrixSDKException
  
  client: BaseClient
  
  try:
      bitrix_response = client.crm.requisite.userfield.delete(
          bitrix_id=235,
      ).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}")

• BX24.js

  BX24.callMethod(
      "crm.requisite.userfield.delete",
      {
          id: 235
      },
      function(result)
      {
          if(result.error())
              console.error(result.error());
          else
              console.info(result.data());
      }
  );

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call(
      'crm.requisite.userfield.delete',
      [
          'id' => 235
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

• Go

  // client and ctx are already created — see the Go SDK section
  res, err := client.Core().Call(ctx, "crm.requisite.userfield.delete", b24.Params{
  	"id": 235,
  })
  if err != nil {
  	return fmt.Errorf("crm.requisite.userfield.delete: %w", err)
  }
  
  var ok bool
  if err := json.Unmarshal(res.Result, &ok); err != nil {
  	return fmt.Errorf("parse response: %w", err)
  }
  fmt.Println("done:", ok)

{% endlist %}

Response Handling

HTTP status: 200

{
    "result": true,
    "time": {
        "start": 1717771689.639506,
        "finish": 1717771690.189804,
        "duration": 0.5502979755401611,
        "processing": 0.10051202774047852,
        "date_start": "2024-06-07T16:48:09+02:00",
        "date_finish": "2024-06-07T16:48:10+02:00",
        "operating": 0.1004788875579834
    }
}

Returned Data

#| || Name type | Description || || result boolean | Result of deleting the user field:

• true — deleted
• false — not deleted || || time time | Information about the request execution time || |#

Error Handling

HTTP status: 40x, 50x

{
    "error": "",
    "error_description": "The entity with ID '235' is not found."
}

{% include notitle Error handling %}

Possible Error Codes

#| || Code | Error text | Description || || Empty string | The entity with ID '235' is not found | The user field with the specified identifier was not found || || Empty string | ID is not defined or invalid | The identifier of the user field is not specified or has an invalid value || || Empty string | Access denied | Insufficient access permissions to delete the user field || || ERROR_CORE | Fail to delete user field | Failed to delete the user field || |#

{% include System errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}