Edit playbook by key

put

https://app.clearpointstrategy.com/api/v1/playbooks/{playbookKey}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

playbookKey

string

required

Playbook Key

Body Params

sortOrder

integer

required

Sort order within category

categorySortOrder

integer

Sort order for the category

playbookKey

string

required

URL-friendly key for the playbook

name

string

required

Display name of the playbook

categoryKey

string | null

Category key for the playbook

categoryName

string | null

Display name of the playbook category

categoryIcon

string | null

Icon for the playbook category

icon

string

Icon name for the playbook

description

string

Brief description of what the playbook does

planTier

string

Plan tier used for server-side playbook filtering

districtIds

array of integers or strings

District restrictions used for server-side playbook filtering

districtIds

playbookType

string

Playbook type used for server-side playbook filtering

definition

object

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultError