Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
AI SDR Knowledge Bases

Update a reengagement card

<Info> **Beta.** This endpoint is in beta. Behavior, parameters, and response shapes may change without notice. </Info>

<small>Requires the ai-sdr:write scope (or a broader one that includes it).</small>

Partial update — send only the fields you want to change. At least one field must be present. Media is not patched here; use the /media sub-resource.

Requires the AI SDR feature on the caller's team.

patch/v3/ai-sdr/knowledge-bases/{knowledge_base_id}/reengagement-cards/{reengagement_card_id}

Path parameters

knowledge_base_idinteger required
reengagement_card_idstring uuid required

Request body

namestring
instructionsstring
sampleAnswerstring
sendAfterinteger
toneOfVoice'confident' | 'persuasive' | 'witty' | 'straightforward' | 'empathetic'

Tone applied to generated replies and reengagement messages.

responseLength'superShort' | 'short' | 'medium' | 'long'

Target length of generated replies and reengagement messages.

linksstring[]
isEnabledboolean
deliveryMode'draft' | 'auto'

How generated reengagement messages for this card are delivered

Example request

{
  "isEnabled": false,
  "sendAfter": 45
}

Response

Reengagement card updated successfully

idstring uuid

Unique identifier for the reengagement card

namestring

Display name of the card

instructionsstring

Instructions for what the reengagement message should say

sampleAnswerstring

Optional sample reengagement message used as a few-shot example

sendAfterinteger

Number of days after the last contact before this card fires

toneOfVoice'confident' | 'persuasive' | 'witty' | 'straightforward' | 'empathetic'

Tone applied to generated replies and reengagement messages.

responseLength'superShort' | 'short' | 'medium' | 'long'

Target length of generated replies and reengagement messages.

linksstring[]

Reference URLs the AI SDR can quote when generating a reengagement message

isEnabledboolean

Whether the card is currently active

deliveryMode'draft' | 'auto'

How generated reengagement messages for this card are delivered

createdAtstring date-time

Timestamp when the card was created

Example response

{
  "id": "9c1f8a7e-0b3a-4d11-9b9c-2c4f8a7e0b3a",
  "name": "30-day silent prospect",
  "instructions": "Gentle nudge with new case study; no hard ask.",
  "sampleAnswer": "Hi {{firstName}}, just sharing a quick case study...",
  "sendAfter": 30,
  "toneOfVoice": "empathetic",
  "responseLength": "short",
  "links": [
    "https://example.com/case-study-northstar"
  ],
  "media": [
    {
      "id": 12345,
      "fileName": "case-study-thumbnail.png",
      "size": 248
    }
  ],
  "isEnabled": true,
  "deliveryMode": "draft",
  "createdAt": "2026-05-10T14:32:11Z"
}