Update a custom field definition

Updates editable custom field definition settings, including the display label, field type, options, and workspace-level default value.

PUT

https://api.channelautomation.com/api/custom-fields/{id}

Path parameters

id
string
required
Custom field definition ID.

Request body JSON required

label
optional
string
field_type
optional
text
or
url
or
number
or
date
or
datetime
or
boolean
+3 more
options
optional
array of
object
is_required
optional
boolean
description
optional
string
display_order
optional
integer
is_active
optional
boolean
default_value
optional
unknown
Workspace-level default value for workspace custom fields.

Returns

200

Custom field updated successfully

400

Invalid custom field parameters

404

Custom field not found

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Update a custom field definition

curl --request PUT \
  --url 'https://api.channelautomation.com/api/custom-fields/<id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "string",
  "field_type": "text",
  "options": [
    {}
  ],
  "is_required": true,
  "description": "string",
  "display_order": 0,
  "is_active": true,
  "default_value": null
}
'

const url = 'https://api.channelautomation.com/api/custom-fields/<id>';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: 'string',
    field_type: 'text',
    options: [{}],
    is_required: true,
    description: 'string',
    display_order: 0,
    is_active: true,
    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/<id>"

payload = {
    "label": "string",
    "field_type": "text",
    "options": [{}],
    "is_required": True,
    "description": "string",
    "display_order": 0,
    "is_active": True,
    "default_value": None
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

Response example

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