Skip to main content
POST
Create a custom field

Authorizations

Authorization
string
header
required

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

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

A user-defined field for storing additional data on contacts.

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