Create Contact Custom Field Definition
Creates a contact custom field definition. The caller must have permission to create custom fields.
Send Content-Type: application/json. Supply only label, field_type, and the fields required for that type. Do not supply IDs, URIs, timestamps, source, question_uuid, or custom_field. Option objects accept only label. Unknown fields are rejected.
Leading and trailing whitespace is removed from the field label. The result must contain 1 to 255 characters. Currency codes are not case-sensitive and are converted to uppercase. Options keep their request order. Duplicate nonblank option labels are allowed. The server assigns option UUIDs. Each response option includes color, which is null when no color is set.
Invalid fields return 400. A field label that already exists returns 409. Field-name checks ignore case. If City exists, creating city returns 409. The default rate limit applies.
Example validation error:
Example duplicate-label error:
Note: Requires CRM on your plan.
contacts:write
Authentication
Request
Field type. Supported values:
text: A text value.number: A numeric value.currency: A monetary amount in the specified currency. Sendcurrencywith this value.tags: A list of text labels.date: A calendar date.single_select: One value from the field’s configured options. Sendoptionswith this value.
System-generated invitee_question fields cannot be created.
Required only for currency fields. Supported codes are USD, EUR, GBP, JPY, CHF, CAD, AUD, CNY, SGD, INR, and KRW. Codes are not case-sensitive. The response uses uppercase. Other field types reject this field.
Required only for single_select fields. Supply 1 to 10 label-only objects in display order. Duplicate labels are allowed. The server assigns option UUIDs. Other field types reject this field.