Create, update and delete custom fields over the API

Custom fields on contacts and companies can now be created, updated and deleted through the API, with the same rules as the app. Previously you could write values to custom fields via the API, but had to create the field itself in the UI first.

  • POST /fields creates a field, or updates it if one with that name already exists. Sending the same request twice is safe to replay, and the response returns 201 on creation or 200 on update.

  • name is the API key you write to and can't be changed afterward. label is the name shown in the app and defaults to name if not set.

  • All field types are supported: text, multiline text, number, date, URL, select, boolean, phone, and user.

  • Select options can be added, renamed or removed by value (matching ignores case and surrounding spaces). Renaming an option updates it on every contact that holds it. At least one option must always remain.

  • Type changes follow the same rules as the UI: any type can switch to text or multiline text, except phone and user.

  • DELETE /fields/{entity}/{name} removes a field and clears its value on every contact or company. This can't be undone, and is blocked if a campaign uses the field to pick its sender.

  • GET /fields now returns select fields with their options, and user fields as type user instead of text.

  • Creating a field is open to anyone. Updating or deleting one requires the "Update contact & companies fields" permission.

To rename a field over the API, update its label — the name key is permanent. If you need a different key, create a new field.

This is an API-only change; nothing changes in the app.