Update a custom field
Rename a field or change a dropdown's options.
PATCH
/api/v1/contact-fields/:idScope
contacts:writeRenames a field or replaces a dropdown's options. The key and type never change, so code that uses the key never breaks when you rename it. To change a field's type, create a new field.
Path parameters
Prop
Type
Body
Send a JSON object.
Prop
Type
Example request
curl -X PATCH "https://api.pedibee.com/api/v1/contact-fields/66f1c2a9e4b0a1b2c3d4e201" \
-H "Authorization: Bearer $PEDIBEE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "Pricing plan",
"options": [
"Free",
"Pro",
"Business",
"Enterprise"
]
}'Response
The updated field. Its key is still plan.
{
"id": "66f1c2a9e4b0a1b2c3d4e201",
"key": "plan",
"label": "Pricing plan",
"type": "SELECT",
"options": [
"Free",
"Pro",
"Business",
"Enterprise"
],
"position": 0,
"createdAt": "2026-10-05T09:30:00.000Z",
"updatedAt": "2026-10-05T09:30:00.000Z"
}Errors
Every error is { "error": "…" } with a message you can show. See Errors and limits.
| Status | When |
|---|---|
400 | The label is invalid, options was sent for a field that isn't SELECT, or a different type or key was sent. |
403 | The key doesn’t have contacts:write, or its creator’s role no longer allows it. |
404 | No field with this id in your workspace. |
409 | Another field already has this label. |
401 | The API key is missing, invalid, revoked or expired. |
429 | Too many requests. Wait for the seconds in Retry-After. |