Create a reengagement card
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 a new follow-up for contacts who have stopped replying. name, instructions and sendAfter are required — sendAfter is the number of days of silence before the card fires and must be at least 1, name is limited to 256 characters and instructions to 2048. sampleAnswer (up to 1024 characters), toneOfVoice, responseLength and links (at most 10 URLs of 256 characters each) shape the message the agent writes; deliveryMode defaults to draft, isEnabled defaults to true, and flowId places the card in a specific reengagement flow instead of the default one. The created card is returned with its assigned id; a sendAfter that clashes with another card in the same flow is rejected as a conflict. 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 reengagement card.
Display name of the card
1 - 256Instructions for what the reengagement message should say
1 - 2048Number of days after the last contact before this card fires
x >= 1Optional sample reengagement message 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 - 256Whether the card should be created in the enabled state (defaults to true on create)
How generated reengagement messages for this card are delivered. Defaults to draft when omitted.
draft, auto Response
Reengagement card created successfully
Detailed representation of a reengagement card.
Unique identifier for the reengagement card
Display name of the card
Instructions for what the reengagement message should say
Optional sample reengagement message used as a few-shot example
Number of days after the last contact before this card fires
x >= 1Tone 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 the AI SDR can quote when generating a reengagement message
Media items attached to this card. Managed via the /media sub-resource.
Whether the card is currently active
How generated reengagement messages for this card are delivered
draft, auto Timestamp when the card was created