Requisite preset fields

Manage the field set of a CRM requisite preset: which fields the preset contains, their captions, their order and whether they appear in the short list. The preset is specified by :presetId in the request path.

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

Operations

• List preset fields — GET /v1/requisite-presets/:presetId/fields
• Get a preset field — GET /v1/requisite-presets/:presetId/fields/:id
• Add a field to a preset — POST /v1/requisite-presets/:presetId/fields
• Update a preset field — PATCH /v1/requisite-presets/:presetId/fields/:id
• Delete a preset field — DELETE /v1/requisite-presets/:presetId/fields/:id
• Fields available to add — GET /v1/requisite-presets/:presetId/fields/available
• Preset field schema — GET /v1/requisite-presets/:presetId/fields/schema

Typical scenario

1. Pick a preset: GET /v1/requisite-presets — its id goes into the path as :presetId.
2. Check which fields can be added: GET /v1/requisite-presets/:presetId/fields/available.
3. Add a field: POST /v1/requisite-presets/:presetId/fields with a fieldName from step 2.
4. Check the preset's field set: GET /v1/requisite-presets/:presetId/fields.

See also

• Requisite presets
• Requisite fields