Create a reply handler
Beta. This endpoint is in beta. Behavior, parameters, and response shapes may change without notice.
ai-sdr:write scope (or a broader one that includes it).
Use this endpoint when you need the AI SDR agent to handle a recurring kind of reply in a particular way — a pricing question, a demo request, a common objection. typeOfQuestion (up to 256 characters) and instructions (up to 2048) are required; sampleAnswer (up to 1024 characters), toneOfVoice, responseLength and links (at most 10 URLs of 256 characters each) shape the answer the agent writes. deliveryMode defaults to draft; choosing stopAndNotify, which routes the reply to a person instead of answering it and can alert the address in additionalNotificationEmail, requires that mode to be enabled for your team. The created handler is returned with its assigned id. The AI SDR feature must be enabled for your team.
Authorizations
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.
Path Parameters
x >= 1Body
Request body for creating a new reply handler.
Short label describing the type of incoming reply this handler covers
1 - 256Instructions for how to handle replies of this type
1 - 2048Optional sample answer used as a few-shot example
1024Tone applied to generated replies and reengagement messages.
confident, persuasive, witty, straightforward, empathetic Target length of generated replies and reengagement messages.
superShort, short, medium, long Reference URLs (max 10; each non-empty, max 256 chars)
101 - 256How generated replies for this handler are delivered. Defaults to draft when omitted.
draft, auto, stopAndNotify Extra recipient notified when a reply is handled with stopAndNotify. Ignored for other delivery modes.
128Response
Reply handler created successfully
Detailed representation of a reply handler.
Unique identifier for the reply handler
Short label describing the type of incoming reply this handler covers
Instructions for how to handle replies of this type
Optional sample answer used as a few-shot example
Tone applied to generated replies
confident, persuasive, witty, straightforward, empathetic Target length for generated replies
superShort, short, medium, long Reference URLs the AI SDR can quote when generating a reply
Media items attached to this reply handler. Managed via the /media sub-resource.
How generated replies for this handler are delivered
draft, auto, stopAndNotify Extra recipient notified when a reply is handled with stopAndNotify. Ignored for other delivery modes.
Timestamp when the reply handler was created