Skip to main content
POST
Create a Prompt Action

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

Body for creating or updating a Prompt Action. Every field is replaced on update, so send the complete definition including the outputs you want to keep.

name
string
required

Name of the Prompt Action

Required string length: 1 - 200
prompt
string
required

Prompt text sent to the model

Required string length: 1 - 4000
outputs
object[]
required

Values the prompt produces. At least one, at most 5. Labels must be unique (trimmed, case-insensitive), and no two outputs may map to the same customFieldId.

Required array length: 1 - 5 elements

Response

The Prompt Action was created

A reusable AI prompt that runs against contacts and writes its results into contact custom fields.

id
integer
required
read-only

Unique identifier of the Prompt Action

name
string
required

Name of the Prompt Action

prompt
string
required

Prompt text sent to the model

outputs
Prompt Action Output · object[]
required

Values the prompt produces, each mapped to a contact custom field

createdAt
string<date-time>
required
read-only

When the Prompt Action was created

lastRunAt
string<date-time> | null
read-only

When the Prompt Action was last run, or null if it has never run