Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
AI SDR Playbooks

Update a playbook

<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. type is immutable.

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

patch/v3/ai-sdr/playbooks/{id}

Path parameters

idstring required

Composite playbook id (g-N / o-N / t-N)

Request body

namestring

Updated display name

descriptionstring

Updated description. Empty string allowed (clears the description).

bodystring

Updated body. Empty string allowed (clears the body).

Example request

{
  "name": "Outbound playbook v3",
  "description": "Refined tone and pacing for cold outreach"
}

Response

Playbook updated successfully

idstring

Composite identifier formatted as {prefix}-{numericId} where the prefix encodes the playbook scope: g for global, o for organization, t for team (e.g. g-1, o-42, t-7).

namestring

Display name of the playbook

descriptionstring

Short description of the playbook's purpose

bodystring

Full playbook body — typically Markdown or plain text instructions the AI SDR follows when this playbook is applied.

type'global' | 'organization' | 'team'

Identifies the visibility scope of a playbook.

  • global — Reply-curated, read-only across all teams.
  • organization — visible to every team in the caller's organization.
  • team — visible to the caller's team only.

global playbooks are never created or modified via the API; only organization and team are accepted on create.

lastUpdatedAtstring date-time

Timestamp of the last modification

authorUserIdinteger nullable

User ID of the playbook author. null for global playbooks and when the original author is no longer a team member.

Example response

{
  "id": "t-7",
  "name": "Outbound playbook v2",
  "description": "Tone and pacing for cold outreach",
  "body": "## Voice\nFriendly, concise, never desperate.\n\n## Pacing\nTwo touches per week max.",
  "type": "team",
  "lastUpdatedAt": "2026-05-10T14:32:11Z",
  "authorUserId": 4821,
  "styleFiles": [
    {
      "id": 12345,
      "fileName": "tone-guide.pdf"
    }
  ]
}