POST
/
v3
/
custom-fields
Create a custom field
curl --request POST \
  --url https://api.reply.io/v3/custom-fields \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "fieldType": "Text",
  "metadata": "<string>",
  "orgWide": false
}
'
{
  "id": 123,
  "title": "<string>",
  "fieldType": "Text",
  "metadata": "<string>",
  "orgWide": true
}

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

Body

application/json
title
string
required

Custom field name

Maximum string length: 90
fieldType
enum<string>
required

Custom field type

Available options:
Text,
Number
metadata
string | null

Optional metadata for the field (e.g., dropdown options)

orgWide
boolean
default:false

Whether the field should be shared across the organization

Response

Custom field created successfully

id
integer

Custom field ID

title
string

Custom field name

fieldType
enum<string>

Custom field type

Available options:
Text,
Number
metadata
string | null

Optional metadata for the field (e.g., dropdown options)

orgWide
boolean

Whether the field is shared across the organization