Edit a custom field

PATCH 
/contacts/fields/:fieldId

Changes the label, the options (the whole list is replaced), the position, or archives the field. An archived field no longer accepts values.

An API key limited to some numbers gets 403: this operation covers the whole base.

Request

Responses

200

Record found.

401

Missing, malformed, unknown or revoked token (authentication), or a suspended account (tenant_inactive).

402

No entitlement (payment_required). The body carries the reason in reason and the way out in action: what to do (kind) and the dashboard page where it is done (url).

403

The resource does not belong to your account (forbidden), or the path is on the mirror's block list (forbidden_endpoint), or your API key is limited to some numbers and the operation covers the whole account (forbidden).

404

Resource does not exist (not_found).

422

Payload failed validation (invalid_request, detailed in issues) or was rejected by Meta (meta_error, with the original body in meta).

429

Rate limit exceeded (rate_limit).

Response Headers

Retry-After

Seconds to wait before retrying.

X-RateLimit-Category

Which rate limit category applied — send, media or default.

X-RateLimit-Scope

Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).

X-RateLimit-Limit

Request ceiling for this category in the current window.

X-RateLimit-Remaining

Requests left in the current window.