Create a custom field definition

Creates a workspace-scoped custom field definition for contacts, appointments, or workspace-level values.

POST

https://api.channelautomation.com/api/custom-fields

Request body JSON required

workspace_id
string
required

name
string
required
label
string
required
field_type
text
or
url
or
number
or
date
or
datetime
or
boolean
+3 more
required
object_type
optional
contact
or
appointment
or
workspace
default: "contact"
options
optional
array of
object
is_required
optional
boolean
description
optional
string
default_value
optional
unknown
Workspace-level default value for object_type=workspace.

Returns

201

Custom field created successfully

400

Missing or invalid custom field parameters

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Create a custom field definition

curl --request POST \
  --url https://api.channelautomation.com/api/custom-fields \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "string",
  "name": "string",
  "label": "string",
  "field_type": "text",
  "object_type": "contact",
  "options": [
    {}
  ],
  "is_required": true,
  "description": "string",
  "default_value": null
}
'

const url = 'https://api.channelautomation.com/api/custom-fields';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspace_id: 'string',
    name: 'string',
    label: 'string',
    field_type: 'text',
    object_type: 'contact',
    options: [{}],
    is_required: true,
    description: 'string',
    default_value: null
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/custom-fields"

payload = {
    "workspace_id": "string",
    "name": "string",
    "label": "string",
    "field_type": "text",
    "object_type": "contact",
    "options": [{}],
    "is_required": True,
    "description": "string",
    "default_value": None
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

Response example

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}