Skip to navigation
API ReferenceV3

Update an org-level playbook

Update a playbook for an organization.

Authentication

AuthorizationBearer

Personal API Key (apk_user_) or Service API Key (apk_)

Path parameters

playbook_idstringRequired

Playbook ID (prefix: playbook-)

org_idstringRequired

Request

This endpoint expects an object.
bodystringRequired
titlestringRequired
macrostring or nullOptional

Playbook macro identifier. Must start with '!' followed by one or more letters, digits, underscores, or hyphens. Example: '!my_macro' or '!my-macro'

Response

Successful Response
access_typeenum

Scope of the playbook: org or enterprise.

Allowed values:
bodystring

Markdown body / instructions of the playbook.

created_atinteger
ISO 8601 timestamp when the playbook was created.
created_bystring
User ID of the playbook creator.
macrostring or null
Shortcut macro for quick reference.
org_idstring or null

Organization that owns this playbook (prefix org-).

playbook_idstring

Unique identifier for the playbook (prefix playbook-).

titlestring
Display title of the playbook.
updated_atinteger
ISO 8601 timestamp of the last update.
updated_bystring
User ID of the last person to update the playbook.

Errors

422
Unprocessable Entity Error