---
sidebar:
  label: roboto.domain.custom_fields
  order: 3
title: roboto.domain.custom_fields
---
## Submodules

- [roboto.domain.custom_fields.custom_field](/docs/reference/python-sdk/roboto/domain/custom_fields/custom_field)
- [roboto.domain.custom_fields.operations](/docs/reference/python-sdk/roboto/domain/custom_fields/operations)
- [roboto.domain.custom_fields.record](/docs/reference/python-sdk/roboto/domain/custom_fields/record)

## Package Contents

- [CUSTOM_FIELD_NAME_PATTERN](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.CUSTOM_FIELD_NAME_PATTERN) (data): `CUSTOM_FIELD_NAME_PATTERN = '[a-z][a-z0-9_]{0,62}'`. Regular expression describing the format of a valid custom-field name.

- [CreateCustomFieldRequest](/reference/python-sdk/roboto/domain/custom_fields/operations#roboto.domain.custom_fields.operations.CreateCustomFieldRequest) (class): Request body for `POST /v1/custom-fields`.

- [CustomField](/reference/python-sdk/roboto/domain/custom_fields/custom_field#roboto.domain.custom_fields.custom_field.CustomField) (class): A typed, queryable schema extension defined by an organization for a Roboto entity type.

- [CustomFieldOptions](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.CustomFieldOptions) (type alias): `type CustomFieldOptions = Annotated[EnumFieldOptions, pydantic.Field(discriminator='field_type')]`. Type-specific configuration carried alongside a custom field. Currently only [`EnumFieldOptions`](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.EnumFieldOptions).

- [CustomFieldRecord](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.CustomFieldRecord) (class): Wire-transmissible representation of a [`CustomField`](/reference/python-sdk/roboto/domain/custom_fields/custom_field#roboto.domain.custom_fields.custom_field.CustomField).

- [CustomFieldStatus](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.CustomFieldStatus) (class): Lifecycle state of a [`CustomField`](/reference/python-sdk/roboto/domain/custom_fields/custom_field#roboto.domain.custom_fields.custom_field.CustomField).

- [CustomFieldType](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.CustomFieldType) (class): Value type of a custom field.

- [EnumFieldOptions](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.EnumFieldOptions) (class): Configuration for an [`CustomFieldType.Enum`](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.CustomFieldType.Enum) custom field.

- [ListCustomFieldsRequest](/reference/python-sdk/roboto/domain/custom_fields/operations#roboto.domain.custom_fields.operations.ListCustomFieldsRequest) (class): Request body for `POST /v1/custom-fields/query`.

- [TargetEntityType](/reference/python-sdk/roboto/domain/custom_fields/record#roboto.domain.custom_fields.record.TargetEntityType) (class): Roboto entity type that a custom field extends.

- [UpdateCustomFieldRequest](/reference/python-sdk/roboto/domain/custom_fields/operations#roboto.domain.custom_fields.operations.UpdateCustomFieldRequest) (class): Request body for `POST /v1/custom-fields/{field_id}`.