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

Update requisite preset

PATCH /v1/requisite-presets/:id

Updates fields of an existing requisite preset. Pass only the fields you want to change — the rest stay unchanged.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionPreset ID. List: GET /v1/requisite-presets

Request fields (body)

Field Type Required Description
Fieldname Typestring Requiredno DescriptionPreset name
Fieldactive Typeboolean Requiredno DescriptionWhether the preset is active
Fieldsort Typenumber Requiredno DescriptionSort order
FieldxmlId Typestring Requiredno DescriptionExternal identifier for synchronization

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/requisite-presets/31" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Company (updated)",
    "sort": 999
  }'

curl — OAuth application

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/requisite-presets/31" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Company (updated)"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/31', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Company (updated)',
    sort: 999,
  }),
})

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/31', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Company (updated)',
  }),
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe updated preset with current field values
Fielddata.id Typenumber DescriptionPreset identifier
Fielddata.entityTypeId Typenumber DescriptionField-set type — 8
Fielddata.countryId Typenumber DescriptionField-set country ID
Fielddata.name Typestring DescriptionPreset name
Fielddata.active Typeboolean DescriptionWhether the preset is active
Fielddata.sort Typenumber DescriptionSort order
Fielddata.xmlId Typestring | null DescriptionExternal identifier
Fielddata.createdAt Typestring DescriptionCreation date (ISO 8601)
Fielddata.updatedAt Typestring DescriptionLast update date (ISO 8601)
Fielddata.createdBy Typenumber DescriptionCreator ID
Fielddata.modifyBy Typenumber | null DescriptionID of the user who performed the update

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 31,
    "entityTypeId": 8,
    "countryId": 122,
    "createdAt": "2026-06-10T09:31:49.000Z",
    "updatedAt": "2026-06-10T09:31:49.000Z",
    "createdBy": 1,
    "modifyBy": null,
    "name": "Company (updated)",
    "xmlId": null,
    "active": true,
    "sort": 999
  }
}

Error response example

404 — preset not found:

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

Errors

HTTP Code Description
HTTP400 CodeREADONLY_FIELD DescriptionA create-only field was sent — countryId or entityTypeId. In the GET /v1/requisite-presets/fields schema they are flagged createOnly
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo preset with this ID found
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the value of one of the fields
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

Known specifics

The entityTypeId and countryId fields are set only at creation. In the GET /v1/requisite-presets/fields schema they come with a createOnly flag and readonly: false — they are writable, but only in the create body. Sending either of them in the update body is rejected with 400 READONLY_FIELD. To use a different country, create a new preset.

See also