Skip to main content
POST
/
v3
/
custom-fields
Create a custom field
curl --request POST \
  --url https://api.reply.io/v3/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "metadata": "<string>",
  "orgWide": false
}
'
{
  "id": 123,
  "title": "<string>",
  "metadata": "<string>",
  "orgWide": true
}

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

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
read-only

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