For AI agents: markdown of this page — /docs-content-en/entities/requisite-presets/preset-fields/delete.md documentation index — /llms.txt

Delete a preset field

DELETE /v1/requisite-presets/:presetId/fields/:id

Deletes a field row from a requisite preset. The field is no longer part of the preset, but it is not removed from the system — it can be added back via POST /v1/requisite-presets/:presetId/fields.

Parameters

Parameter Type Required Description
ParameterpresetId (path) Typenumber Requiredyes DescriptionRequisite preset ID
Parameterid (path) Typenumber Requiredyes DescriptionPreset field row ID (from GET /v1/requisite-presets/:presetId/fields — the id field)

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/1', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/1', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionOperation result
Fielddata.id Typenumber DescriptionID of the deleted preset field row
Fielddata.deleted Typeboolean DescriptionAlways true on successful deletion

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "deleted": true
  }
}

Error response example

404 — field row not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The PresetField with ID '99999' is not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo field row with this id found in the given preset
HTTP400 CodeINVALID_PRESET_ID DescriptionpresetId is not a positive integer
HTTP400 CodeINVALID_FIELD_ID Descriptionid is not a positive integer
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope. Message: This endpoint requires 'crm' scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

Known specifics

Deletion is reversible. The operation removes the field from the preset but does not destroy it in the system. The field can be added back via POST /v1/requisite-presets/:presetId/fields.

Re-read the list before deleting. A field row id is positional and may change after the preset composition changes. Take the current id from a fresh field list, finding the row by fieldName — otherwise the deletion may hit a different field.

See also