Skip to main content

Detailed representation of a playbook, returned by get/create/update responses.

id
string
read-only

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).

name
string

Display name of the playbook

description
string

Short description of the playbook's purpose

body
string

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

type
enum<string>

Visibility scope of the playbook. Set on create and immutable thereafter.

Available options:
global,
organization,
team
lastUpdatedAt
string<date-time>
read-only

Timestamp of the last modification

authorUserId
integer | null

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

styleFiles
PlaybookStyleFile · object[]
read-only

Style files attached to the playbook. Managed via the /style-files sub-resource — uploads are immediate, deletes are immediate; the field is read-only on the playbook payload.