Create a custom field

Defines a new field. Send a label, and the key is derived from it.

type is one of text, number, date, select. A select needs options, at least one and at most 50, and a value is then checked against them, case-insensitively.

A label whose key matches a standard contact variable, such as name, phone or timezone, is refused, because the field would replace that value in the agent’s prompt. caller_pref is refused too, because it holds the contact’s memory.

Cookie-auth callers must send the x-csrf-token header.

Required API key scope: contacts:write.

POST

api

native-contacts

fields

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/native-contacts/fields \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "Service needed",
  "type": "select",
  "options": [
    "Implants",
    "Whitening",
    "Check-up"
  ]
}'

import requests

url = "https://api.teamfollowup.ai/api/native-contacts/fields"

payload = { "label": "Service needed" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: 'Service needed'})
};

fetch('https://api.teamfollowup.ai/api/native-contacts/fields', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => 'Service needed'
  ]),
  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"

	payload := strings.NewReader("{\n  \"label\": \"Service needed\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.teamfollowup.ai/api/native-contacts/fields")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"Service needed\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/native-contacts/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"Service needed\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "key": "service_needed",
    "label": "Service needed",
    "type": "select",
    "options": [
      "Implants",
      "Whitening",
      "Check-up"
    ]
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId

string

required

The sub-account these contacts belong to. Your access to it is checked on every call. A sub-account with a CRM answers 400.

Body

application/json

The field.

label

string

required

The field's name. Its key, which a prompt reads as {{key}}, is made from it and never changes.

Maximum string length: 60

Example:

"Service needed"

type

enum<string>

Defaults to text.

Available options:

text,

number,

date,

select

Example:

"select"

options

string[]

Required for select, at least one.

Maximum array length: 50

{key}

any

Response

The field as defined, with the key your prompts will use.

success

boolean

required

data

object

required

Show child attributes

{key}

any

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/native-contacts/fields \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "Service needed",
  "type": "select",
  "options": [
    "Implants",
    "Whitening",
    "Check-up"
  ]
}'

import requests

url = "https://api.teamfollowup.ai/api/native-contacts/fields"

payload = { "label": "Service needed" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: 'Service needed'})
};

fetch('https://api.teamfollowup.ai/api/native-contacts/fields', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => 'Service needed'
  ]),
  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"

	payload := strings.NewReader("{\n  \"label\": \"Service needed\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.teamfollowup.ai/api/native-contacts/fields")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"Service needed\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/native-contacts/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"Service needed\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "key": "service_needed",
    "label": "Service needed",
    "type": "select",
    "options": [
      "Implants",
      "Whitening",
      "Check-up"
    ]
  }
}

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Caller ID

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Create a custom field

Authorizations

Query Parameters

Body

Response