# Update custom field

Endpoint: PATCH /api/internal/custom-fields/{id}/
Version: 2.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `ordering` (string)
    Which field to use when ordering the results.

  - `search` (string)
    A search term.

## Request fields (application/json):

  - `entity_type` (string, required)
    Enum: "property", "owner"

  - `group_id` (integer)

  - `label` (string, required)

  - `field_type` (string, required)
    Enum: "text", "text_input", "url", "boolean", "number", "phone", "money", "date", "select", "multiselect"

  - `required` (boolean)

  - `position` (integer)

  - `is_active` (boolean)

  - `options` (array)

  - `options.label` (string, required)

  - `options.is_active` (boolean)

  - `options.position` (integer)

  - `options.uuid` (string)

  - `placeholder` (string)
    Optional placeholder text for the custom_field

## Response 200 fields (application/json):

  - `id` (integer)

  - `entity_type` (string, required)
    Enum: "property", "owner"

  - `group` (object)

  - `group.id` (integer)

  - `group.label` (string, required)

  - `uuid` (string)

  - `label` (string, required)

  - `field_type` (string, required)
    Enum: "text", "text_input", "url", "boolean", "number", "phone", "money", "date", "select", "multiselect"

  - `required` (boolean)

  - `position` (integer)

  - `is_active` (boolean)

  - `options` (array)

  - `options.id` (integer)

  - `options.label` (string, required)

  - `options.is_active` (boolean)

  - `options.created` (string)

  - `options.updated` (string)

  - `options.position` (integer)

  - `options.uuid` (string)

  - `options.field_id` (integer)

  - `created` (string)

  - `updated` (string)

  - `account_id` (integer)

  - `machine_name` (string)
    Machine-friendly key for integrations, e.g., 'custom_field'

  - `placeholder` (string)
    Optional placeholder text for the custom_field

## Response 400:

  - `400` (unknown)
    Bad request: the body or parameters failed validation. The body names each invalid field.

## Response 401:

  - `401` (unknown)
    Missing or invalid API key. Send `Authorization: Api-Key YOUR_OPEN_API_KEY`.

## Response 401 fields (application/json):

  - `detail` (string, required)

## Response 403:

  - `403` (unknown)
    The key is valid, but its user lacks permission, or the plan does not include this capability.

## Response 403 fields (application/json):

  - `detail` (string, required)

## Response 404:

  - `404` (unknown)
    The resource does not exist or is not in this account.

## Response 404 fields (application/json):

  - `detail` (string, required)

## Response 429:

  - `429` (unknown)
    Rate limit exceeded (120 requests/minute and 5,000 requests/hour per account, per service). Wait the number of seconds in the message, then retry.

## Response 429 fields (application/json):

  - `detail` (string, required)

## Response 429 headers (application/json):

  - `Retry-After` (integer)
    Seconds to wait before retrying, when the server can tell.

## Response 500:

  - `500` (unknown)
    Unexpected server error. Retry with exponential backoff; report it if it persists. The body may be HTML rather than JSON.

