# `PolarExpress.Services.CustomFieldsService`
[🔗](https://github.com/jeffhuen/polar_express/blob/main/lib/polar_express/services/custom_fields_service.ex#L2)

Custom-fields

CustomFields API operations.

# `create_custom_field`

```elixir
@spec create_custom_field(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.CustomField.t()} | {:error, PolarExpress.Error.t()}
```

Create Custom Field

Create a custom field.

**Scopes**: `custom_fields:write`

See `PolarExpress.Params.CustomFieldsCreateCustomFieldParams` for parameter details.

# `delete_custom_field`

```elixir
@spec delete_custom_field(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, PolarExpress.Error.t()}
```

Delete Custom Field

Delete a custom field.

**Scopes**: `custom_fields:write`

See `PolarExpress.Params.CustomFieldsDeleteCustomFieldParams` for parameter details.

# `get_custom_field`

```elixir
@spec get_custom_field(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.CustomField.t()} | {:error, PolarExpress.Error.t()}
```

Get Custom Field

Get a custom field by ID.

**Scopes**: `custom_fields:read` `custom_fields:write`

See `PolarExpress.Params.CustomFieldsGetCustomFieldParams` for parameter details.

# `list_custom_fields`

```elixir
@spec list_custom_fields(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}
```

List Custom Fields

List custom fields.

**Scopes**: `custom_fields:read` `custom_fields:write`

See `PolarExpress.Params.CustomFieldsListCustomFieldsParams` for parameter details.

# `update_custom_field`

```elixir
@spec update_custom_field(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.CustomField.t()} | {:error, PolarExpress.Error.t()}
```

Update Custom Field

Update a custom field.

**Scopes**: `custom_fields:write`

See `PolarExpress.Params.CustomFieldsUpdateCustomFieldParams` for parameter details.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
