Update a custom contact field

PATCH/api/v1/contact-fields/{id}

PATCH /contact-fields/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/contact-fields/cf_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "object": "contact_field",
  "id": "id_123",
  "key": "string",
  "label": "string",
  "type": "text",
  "default_value": "string",
  "position": 0,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update a custom field's editable metadata, such as its display label. The key and type are immutable here — to change the key (and migrate every contact's stored value) use Rename a custom field's key instead. Requires the contacts:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body4 fields

Field	Type	Description
`label`	string	—
`type`	enumtext \| number \| boolean \| date	—
`position`	integer	—
`default_value`	object	—

Response · 200 fields9 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`key`required	string	—
`label`required	string	—
`type`required	enumtext \| number \| boolean \| date	—
`default_value`required	object	—
`position`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404422

Update a custom contact field

Update a custom contact field

Search docs and guides