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
entityType
enum<string>
default:contact

The entity the field belongs to. Omit it for a contact field. An account field cannot carry an aiDefinition.

Available options:
contact,
account
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

aiDefinition
object

Makes the field an AI custom field, filled by running this prompt against a contact. Omit it for a field you fill yourself.

Example:

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
entityType
enum<string>

The entity the field belongs to. A contact field holds a value on each contact, an account field on each account.

Available options:
contact,
account
metadata
string | null

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

orgWide
boolean

Whether the field is shared across the organization

fieldSource
enum<string>

What fills the field. regular is one you fill yourself, ai one that carries its own prompt in aiDefinition, and promptAction one written by the Prompt Actions listed in promptActions. Only an ai field can be previewed or enriched; only a field that is not ai can be mapped to a Prompt Action output.

Available options:
regular,
ai,
promptAction
aiDefinition
AI Field Definition · object | null

The prompt that fills the field. Present only when fieldSource is ai; null otherwise.

Example:
promptActions
Custom Field Prompt Action · object[]

The Prompt Actions that write into this field. Empty unless fieldSource is promptAction.