Para agentes de IA: markdown desta página — /docs-content-en/entities/requisite-presets.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

Requisite presets

Presets for requisite field sets. The built-in presets depend on the account country — an international Bitrix24 account has Company and Person. A preset defines which fields are available on a requisite and serves as the source of presetId for creating a requisite via POST /v1/requisites.

Bitrix24 API: crm.requisite.preset.* Scope: crm

Create requisite preset

POST /v1/requisite-presets

Creates a new preset — a template for a set of requisite fields. After creation, the preset becomes available as a presetId source for POST /v1/requisites. A deleted preset cannot be restored — create a new one if needed.

Request fields (body)

Field Type Required Description
entityTypeId number yes Field-set type — always 8, requisite
name string yes Preset name ("Company", "Person")
countryId number no Field-set country ID, for example 122. The value depends on the account country
active boolean no Whether the preset is active. Defaults to true
sort number no Sort order. Defaults to 500
xmlId string no External identifier for synchronization

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 8,
    "name": "Company",
    "countryId": 122,
    "active": true,
    "sort": 100
  }'

curl — OAuth app

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 8,
    "name": "Company",
    "countryId": 122
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityTypeId: 8,
    name: 'Company',
    countryId: 122,
    active: true,
    sort: 100,
  }),
})

const { success, data } = await res.json()
console.log('Created preset ID:', data.id)

JavaScript — OAuth app

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

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

Response fields

Field Type Description
success boolean Always true on success
data object The created preset
data.id number ID of the new preset
data.entityTypeId number Field-set type — 8
data.countryId number Field-set country ID
data.name string Preset name
data.active boolean Whether the preset is active
data.sort number Sort order
data.xmlId string | null External identifier
data.createdAt string Creation date (ISO 8601)
data.updatedAt string | null null right after creation
data.createdBy number Creator ID
data.modifyBy number | null null right after creation

Response example

HTTP status: 201 Created

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

Error response example

422 — Bitrix24 rejected the request (a required field was not provided):

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "ENTITY_TYPE_ID is not defined or invalid."
  }
}

Errors

HTTP Code Description
422 BITRIX_ERROR Bitrix24 rejected the request — a required field was not provided or an invalid value was passed (the error text contains the field name)
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

The preset contains no fields after creation. Right after creation the preset's field set is empty. To add fields (company name, VAT ID, address, and so on), use POST /v1/requisite-presets/:presetId/fields. The list of fields available to add — GET /v1/requisite-presets/:presetId/fields/available.

See also