Create a custom field
POST/contacts/fields
A new field for contacts. key and type cannot change later. The select and
multi_select types require options; the others do not accept them.
An API key limited to some numbers gets 403: this operation covers the whole base.
Request
Responses
- 201
- 401
- 402
- 403
- 409
- 422
- 429
Contact created.
Missing, malformed, unknown or revoked token (authentication), or a suspended
account (tenant_inactive).
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).
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).
contact_field_exists (the key already exists) or contact_field_limit_reached (the plan reached its field cap, archived ones included).
Payload failed validation (invalid_request, detailed in issues) or was
rejected by Meta (meta_error, with the original body in meta).
Rate limit exceeded (rate_limit).
Response Headers
Seconds to wait before retrying.
Which rate limit category applied — send, media or default.
Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).
Request ceiling for this category in the current window.
Requests left in the current window.