Create custom field
POST
https://app.sendapp.ai/api/contact-fields
Creates a new custom contact field, with the same rules as the Custom fields page. The field is added at the end of the list.
Responses:
201 Created with the new field — 409 if a field with the same name already exists (case-insensitive) — 422 if a value is not valid (the message lists the valid types).Available types:
input, textarea, number, date, select, multiselect, boolean, url, phone, email, ai. options is set only for select and multiselect, ai_prompt only for ai.Common errors:
401 if the API key is missing or wrong — 403 if the plan has expired or does not include API access — 429 if you send too many requests in a short time or another change to your account's custom fields is in progress: try again after a few seconds.Parameters
8 · 3 required
apikey
required
Your API Key (the
X-API-Key header also works).
name
required
Field name, up to 255 characters. It must be unique in your account: it is the name you use to write the value on a contact.
type
required
Field type:
input, textarea, number, date, select, multiselect, boolean, url, phone, email or ai.
options
optional
Only for
select and multiselect (required): array of choices, 1 to 50, unique, each up to 60 characters. A comma-separated string is accepted too.
ai_prompt
optional
Only for
ai (required): what the AI should extract from the conversations, up to 500 characters.
show_in_list
optional
true to show it as a column in the contacts list (default false).
visible_to_ai
optional
true if the AI assistant can read its value (default true).
is_required
optional
true to make it required in the contact form (default false). Not allowed for
ai fields.
Need help with the integration? info@sendapp.live