# Required CRM fields

Read, set and clear the required property of one CRM field. Changes affect CRM cards and record saving for **all users of the Bitrix24 account**.

Bitrix24 API: `crm.<entity>.field.required.{get,set,clear}`
Scope: `crm`

> **Rolling out with `crm 26.2000.0`.** Availability depends on the Bitrix24 account. A disabled feature or missing portal method returns `422 METHOD_NOT_YET_AVAILABLE` with `error.release`. The release line alone does not guarantee that the method is enabled.

Standard field identifiers use native CRM names. The amount field is `opportunity`, although the V1 entity API calls it `amount`. V1 aliases are not converted.

For a custom field, use the original `UF_*` value from `fieldName` in [CRM user fields](/docs/userfields/crm) or [smart process user fields](/docs/userfields/smart-processes). Smart invoices use `/v1/userfields/invoices`. Do not use the `ufCrm...` alias from the entity dictionary. Field identifiers are not converted.

## Operations

- [Read requirement](./crm-required-fields/get.md) — `GET /v1/deals/fields/required`
- [Set requirement](./crm-required-fields/set.md) — `PUT /v1/deals/fields/required`
- [Clear requirement](./crm-required-fields/clear.md) — `DELETE /v1/deals/fields/required`

## Resources

Use the same suffix `/fields/required` for these resources:

- `/v1/deals/fields/required`
- `/v1/leads/fields/required`
- `/v1/contacts/fields/required`
- `/v1/companies/fields/required`
- `/v1/quotes/fields/required`
- `/v1/invoices/fields/required`
- `/v1/items/:entityTypeId/fields/required`

For smart processes, use `entityTypeId` from [GET /v1/smart-processes](/docs/entities/smart-processes/list). Built-in types use the named resources above. Field identifiers are passed unchanged. Get field identifiers from the corresponding entity [field dictionary](/docs/entities/deals/fields). Funnel IDs: [deal categories](/docs/entities/deal-categories/list) or [categories](/docs/entities/categories/list). Stage identifiers: [statuses](/docs/entities/statuses/list).

## Access and behavior

Reading allows a `READONLY` key. Changes require `READWRITE`. Bitrix24 checks field, funnel, stage and permission rules. Omitting `requiredStageIds` makes a field required throughout the funnel or globally for entities without stages. A non-empty list selects stages. `[]` clears the setting. A mandatory system field may remain globally required after clearing the setting.