Update custom field

PUT https://app.sendapp.ai/api/contact-fields/{id}

Changes a custom field. The update is partial: the keys you do not send stay as they are. PATCH is accepted too. Values already saved on contacts are kept.

You can change the type too, with the same rules as creation: switching to select/multiselect needs options (if the field already had them, they stay), switching to ai needs ai_prompt and the field stops being required.

Responses: 200 with the field and the changed list of the settings that changed — 404 if the field is not in your account — 409 if the new name is already used by another field — 422 if a value is not valid.

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

9 · 2 required

apikey required

Your API Key (the X-API-Key header also works).

id required

Field ID (integer, in the path). Use GET /api/contact-fields to find it.

name optional

New name (unique in your account).

type optional

Field type: input, textarea, number, date, select, multiselect, boolean, url, phone, email or ai.

options optional

The complete list of the new choices (replaces the current one).

ai_prompt optional

New prompt (ai fields).

show_in_list optional

true to show it as a column in the contacts list, false to remove it. If you do not send it, it stays as it is.

visible_to_ai optional

true if the AI assistant can read its value, false if not. If you do not send it, it stays as it is.

is_required optional

true to make it required in the contact form, false to remove that. If you do not send it, it stays as it is. Not allowed for ai fields.

Need help with the integration? info@sendapp.live

curl -X PATCH 'https://app.sendapp.ai/api/contact-fields/13' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "options": ["S", "M", "L", "XL"], "show_in_list": true }'

<?php $ch = curl_init('https://app.sendapp.ai/api/contact-fields/13'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY', 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode(['options' => ['S', 'M', 'L', 'XL'], 'show_in_list' => true]), ]); echo curl_exec($ch); curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/contact-fields/13', { method: 'PATCH', headers: { 'X-API-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({ options: ['S', 'M', 'L', 'XL'], show_in_list: true }) }); console.log(await res.json());

{ "status": "success", "message": "Field updated.", "changed": ["options", "show_in_list"], "field": { "id": 13, "name": "Size", "type": "select", "options": ["S", "M", "L", "XL"], "show_in_list": true, "...": "..." } }