Archive a playbook | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/playbook/id/archive/ \
     -u "<CLOSE_API_KEY>:"

{
  "archived_at": "2025-07-29T11:00:00.000000+00:00",
  "archived_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "created_at": "2025-07-29T10:30:00.000000+00:00",
  "created_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "custom_field_ids": [
    "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
    "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c"
  ],
  "description": "Initial discovery call with prospect.",
  "id": "convtyp_03oUxZfoO6e2vHmcz1DiHR",
  "name": "Discovery Call",
  "organization_id": "orga_AbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "outcome_ids": [
    "outcome_030Xl5QwKi7tPRLRtnuef3",
    "outcome_03oUxZfoO6e2vHmcz1DiHR"
  ],
  "summary_guidance": "Summarize the prospect's pain points and next steps.",
  "updated_at": "2025-07-29T10:30:00.000000+00:00",
  "updated_by_id": "user_A6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

Archive an existing playbook. Archived playbooks are hidden from active listings but retain their associated history.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

Successful response

archived_atdatetime or null

archived_by_idstring or null

created_atdatetime

created_by_idstring

custom_field_idslist of strings

descriptionstring or null

idstring

namestring

organization_idstring

outcome_idslist of strings

summary_guidancestring or null

updated_atdatetime

updated_by_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error