Create a Contact Custom Field via the ChatbotX API

Custom fields extend the default contact profile with the data that matters most to your business. Use this endpoint to create a new custom field in your workspace. You must supply a unique name and a type that matches the kind of data you want to store. Optionally, you can assign the field to an existing folder to keep things organised.

POST /api/v1/custom-fields

Request Body

string

required

A unique name for the custom field. Must be between 1 and 255 characters.

string

required

The data type for the field. Accepted values: shortText, longText, number, date, datetime, boolean, email, phoneNumber.

string | null

The ID of the folder to place this field in. Pass null or omit to leave the field unorganised.

Code Examples

curl --request POST \
  --url https://app.chatbotx.io/api/v1/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Account Tier",
    "type": "shortText",
    "folderId": null
  }'

import requests

url = "https://app.chatbotx.io/api/v1/custom-fields"

payload = {
    "name": "Account Tier",
    "type": "shortText",
    "folderId": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Account Tier',
    type: 'shortText',
    folderId: null
  })
};

fetch('https://app.chatbotx.io/api/v1/custom-fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 201 Created with the newly created custom field object.

Response Fields

string

required

The unique identifier for the created custom field.

string

required

The name of the newly created custom field.

string

required

The data type of the field. One of shortText, longText, number, date, datetime, boolean, email, or phoneNumber.

string | null

required

An optional description, or null if none was provided.

Example Response

{
  "id": "103",
  "name": "Account Tier",
  "type": "shortText",
  "description": null
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

Create a Contact Custom Field via the ChatbotX API

Request Body

Code Examples

Response

Response Fields

Example Response

​Request Body

​Code Examples

​Response

​Response Fields

​Example Response

Request Body

Code Examples

Response

Response Fields

Example Response