Ferndesk

Update a playbook

Changes the fields you send and keeps the rest. Turning a playbook off never needs a paid plan. An id the workspace does not have yet adds a playbook with that id, as Create a playbook does.

PATCH /v1/playbooks/{id}
Bearer token scope settings:write

Path parameters

· 1
id string · min length: 1 required

Body

required application/json
name string · min length: 1· max length: 120

Needed to add a playbook.

when string · max length: 300

The situation it covers, in plain words.

steps array of string · max items: 20

What the agent does, in order. Keep mention tokens such as @[custom.plan-lookup] as they are.

enabled boolean

Only enabled playbooks reach the agent. A new playbook is off unless this is true.

conditions any

What a conversation must pass for the agent to see it: { all: [...] } of { field, op, values, not? }. Fields: channel (email, chat, slack; chat is the widget and the help center), priority, tag (label ids), property ({ field: "property", key, op, values }, the customer's properties, verified customers only), customerGroup (customer group ids). Conditions on one field widen, different fields narrow, not hides. Null runs it on every conversation; left out keeps what it has.

Responses