CLclose
playbooks

Create a playbook

Changed on

Create a new playbook for the organization.

post/playbook/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/playbook/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Request body

custom_field_idsstring[]

IDs of Shared Custom Fields to associate with this Playbook.

descriptionstring nullable

Description of the playbook.

namestring required
outcome_idsstring[]

IDs of Outcomes that should be associated with this Playbook.

summary_guidancestring nullable

Guidance for AI summaries of calls and meetings associated with this Playbook.

Response

Successful response

archived_atstring date-time nullable required
archived_by_idstring nullable required
created_atstring date-time required
created_by_idstring required
custom_field_idsstring[] required
descriptionstring nullable required
idstring required
namestring required
organization_idstring required
outcome_idsstring[] required
positioninteger nullable required
summary_guidancestring nullable required
updated_atstring date-time required
updated_by_idstring required

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • b438a9d2998eRevision changes
    • info

      endpoint added