Skip to main content
POST
/
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": "<string>",
  "metadata": "<string>",
  "orgWide": false
}
'
{
  "id": 123,
  "title": "<string>",
  "fieldType": "<string>",
  "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

​
fieldType
string
required

Custom field type

​
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
required

Custom field ID

​
title
string
required

Custom field name

​
fieldType
string
required

Custom field type

​
metadata
string | null

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

​
orgWide
boolean

Whether the field is shared across the organization