Skip to main content
POST
Run a Prompt Action on contacts

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
promptActionId
integer
required

Prompt Action to run

Required range: x >= 1
contactIds
integer[]
required

Contact IDs to run the Prompt Action on. At least one, at most 1000. Each ID must be positive.

Required array length: 1 - 1000 elements
conflictResolution
enum<string>
default:override

What to do when a target custom field already holds a value. override replaces it; keepExisting leaves it untouched.

Available options:
override,
keepExisting

Response

The run was accepted and started. contactsAccepted is the number of contacts the run will process, which can be fewer than you sent when some IDs are not accessible to your team.

jobId
string<uuid>
required

Background job id; poll GET /v3/background-jobs/{jobId}.

contactsAccepted
integer
required

Number of contacts the run will process

creditsReserved
integer
required

Reply credits reserved up front for the run