# custom-fields

> Custom contact field definitions.

Custom contact field definitions.

| Method | Path | Operation | Scope | Test mode |
|---|---|---|---|---|
| GET | `/v1/custom-fields` | `custom_fields_list`: Custom field definitions | `contacts:read` | - |
| POST | `/v1/custom-fields` | `custom_fields_create`: Define a custom field | `contacts:write` | - |
| DELETE | `/v1/custom-fields/{field_id}` | `custom_fields_delete`: Delete a custom field (values stay in contacts until overwritten) | `contacts:write` | - |
| GET | `/v1/custom-fields/{field_id}` | `custom_fields_get`: Get a custom field | `contacts:read` | - |
| PATCH | `/v1/custom-fields/{field_id}` | `custom_fields_update`: Update a custom field (label, options, PII flag) | `contacts:write` | - |

Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`.
