Skip to main content
PUT
PutLeadPlaybookAPI saves the playbook text, reads it into the typed

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Body

application/json
body
string
required
agent_id
string
daily_contact_cap
integer<int64>
enabled
boolean
handoff_alert_recipients
string[]
signature_name
string

Response

Success response

agent
PlaybookAgent is the concierge a playbook names, as the API returns it. · object
agent_id
string

the same organization. Null when none is linked.

body
string
daily_contact_cap
integer<int64>
enabled
boolean
exists
boolean

then carries the default template and ReadBack is empty.

handoff_alert_recipients
string[]

handoff — a decision it cannot carry out, which needs a person at the sales desk. Empty means the alert is off: there is no default audience and no fallback to the organization's members, so a development that has not filled this in is told nothing and no email is sent.

It is deliberately not on a playbook REVISION, unlike SignatureName: it is who gets told, not what a decision says, so it is read live at send time and changing it takes effect at once rather than at the next save. See migration 012.

policy_digest
string

a decision that is genuinely out of date from one whose playbook has merely been re-saved. A decision whose policy_digest equals this one was decided under the playbook as it stands; one that differs is due to be decided again, and the sweep will. See policy.go.

read_back
ReadBack is what Erdo understood from a playbook's text when it was saved. · object

Only Actions[].Mode and WorkingHours are enforced; the stages and the priority ladder are a picture of the text drawn for the person who wrote it, and every evaluation still reads the whole text.

revision
integer<int64>
signature_name
string

signed and sent as, and what a call brief opens with. Empty falls back to the linked concierge's display name, which is what every playbook written before this setting existed does. See writeIdentitySection.

updated_at
string<date-time>
updated_by
string