cURL
curl --request PATCH \
--url https://api.teamfollowup.ai/api/native-contacts/fields/{key} \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"label": "Treatment wanted",
"options": [
"Implants",
"Whitening",
"Check-up",
"Veneers"
]
}'import requests
url = "https://api.teamfollowup.ai/api/native-contacts/fields/{key}"
payload = {
"label": "Treatment wanted",
"options": ["Implants", "Whitening", "Check-up", "Veneers"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: 'Treatment wanted',
options: ['Implants', 'Whitening', 'Check-up', 'Veneers']
})
};
fetch('https://api.teamfollowup.ai/api/native-contacts/fields/{key}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.teamfollowup.ai/api/native-contacts/fields/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'Treatment wanted',
'options' => [
'Implants',
'Whitening',
'Check-up',
'Veneers'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.teamfollowup.ai/api/native-contacts/fields/{key}"
payload := strings.NewReader("{\n \"label\": \"Treatment wanted\",\n \"options\": [\n \"Implants\",\n \"Whitening\",\n \"Check-up\",\n \"Veneers\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.teamfollowup.ai/api/native-contacts/fields/{key}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Treatment wanted\",\n \"options\": [\n \"Implants\",\n \"Whitening\",\n \"Check-up\",\n \"Veneers\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/native-contacts/fields/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Treatment wanted\",\n \"options\": [\n \"Implants\",\n \"Whitening\",\n \"Check-up\",\n \"Veneers\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"key": "service_needed",
"label": "Treatment wanted",
"type": "select",
"options": [
"Implants",
"Whitening",
"Check-up",
"Veneers"
]
}
}{
"success": false,
"error": "A phone number is required."
}{
"success": false,
"error": "Unauthorized"
}{
"success": false,
"error": "You do not have access to this sub-account."
}{
"success": false,
"error": "Contact not found."
}{
"success": false,
"error": "TooManyRequests"
}{
"success": false,
"error": "Contacts request failed."
}Update a custom field
Changes a field’s label or its dropdown choices. The key never moves, so nothing that reads {{key}} breaks.
Removing a choice from a select does not rewrite contacts that already hold it; it stops being offered from here on.
Cookie-auth callers must send the x-csrf-token header.
Required API key scope: contacts:write.
PATCH
/
api
/
native-contacts
/
fields
/
{key}
cURL
curl --request PATCH \
--url https://api.teamfollowup.ai/api/native-contacts/fields/{key} \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"label": "Treatment wanted",
"options": [
"Implants",
"Whitening",
"Check-up",
"Veneers"
]
}'import requests
url = "https://api.teamfollowup.ai/api/native-contacts/fields/{key}"
payload = {
"label": "Treatment wanted",
"options": ["Implants", "Whitening", "Check-up", "Veneers"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: 'Treatment wanted',
options: ['Implants', 'Whitening', 'Check-up', 'Veneers']
})
};
fetch('https://api.teamfollowup.ai/api/native-contacts/fields/{key}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.teamfollowup.ai/api/native-contacts/fields/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'Treatment wanted',
'options' => [
'Implants',
'Whitening',
'Check-up',
'Veneers'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.teamfollowup.ai/api/native-contacts/fields/{key}"
payload := strings.NewReader("{\n \"label\": \"Treatment wanted\",\n \"options\": [\n \"Implants\",\n \"Whitening\",\n \"Check-up\",\n \"Veneers\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.teamfollowup.ai/api/native-contacts/fields/{key}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Treatment wanted\",\n \"options\": [\n \"Implants\",\n \"Whitening\",\n \"Check-up\",\n \"Veneers\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/native-contacts/fields/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Treatment wanted\",\n \"options\": [\n \"Implants\",\n \"Whitening\",\n \"Check-up\",\n \"Veneers\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"key": "service_needed",
"label": "Treatment wanted",
"type": "select",
"options": [
"Implants",
"Whitening",
"Check-up",
"Veneers"
]
}
}{
"success": false,
"error": "A phone number is required."
}{
"success": false,
"error": "Unauthorized"
}{
"success": false,
"error": "You do not have access to this sub-account."
}{
"success": false,
"error": "Contact not found."
}{
"success": false,
"error": "TooManyRequests"
}{
"success": false,
"error": "Contacts request failed."
}Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Path Parameters
The field key.
Minimum string length:
1Query Parameters
The sub-account. It is the only thing that identifies the tenant on these routes, and it is re-checked against your access on every call. A sub-account that keeps its contacts in a CRM answers 400.
Body
application/json
What to change.
⌘I
