Reply Handler - Reply API Documentation

{
  "id": "9c1f8a7e-0b3a-4d11-9b9c-2c4f8a7e0b3a",
  "typeOfQuestion": "Pricing inquiry",
  "instructions": "Quote our published tiered pricing; offer a discovery call for enterprise.",
  "sampleAnswer": "Thanks for asking! Our tiered pricing starts at $X...",
  "toneOfVoice": "confident",
  "responseLength": "medium",
  "links": [
    "https://example.com/pricing"
  ],
  "media": [
    {
      "id": 12345,
      "fileName": "pricing-tiers.png",
      "size": 248
    }
  ],
  "deliveryMode": "draft",
  "additionalNotificationEmail": null,
  "createdAt": "2026-05-10T14:32:11Z"
}

Detailed representation of a reply handler.

string<uuid>

read-only

Unique identifier for the reply handler

typeOfQuestion

string

Short label describing the type of incoming reply this handler covers

instructions

string

Instructions for how to handle replies of this type

sampleAnswer

string

Optional sample answer used as a few-shot example

toneOfVoice

enum<string>

Tone applied to generated replies

Available options:

confident,

persuasive,

witty,

straightforward,

empathetic

responseLength

enum<string>

Target length for generated replies

Available options:

superShort,

short,

medium,

long

links

string[]

Reference URLs the AI SDR can quote when generating a reply

media

KnowledgeBaseMedia · object[]

read-only

Media items attached to this reply handler. Managed via the /media sub-resource.

Show child attributes

deliveryMode

enum<string>

How generated replies for this handler are delivered

Available options:

draft,

auto,

stopAndNotify

additionalNotificationEmail

string | null

Extra recipient notified when a reply is handled with stopAndNotify. Ignored for other delivery modes.

createdAt

string<date-time>

read-only

Timestamp when the reply handler was created