> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Archive a playbook definition

POST https://api.cloudraker.com/playbooks/{playbookId}/archive

Transitions the playbook identified by `playbookId` to `archived` status, retiring it from active use. Authorization: organization administrators only — other callers are rejected with 403. No request body. Response: `{ data: Playbook }` with the updated status.

Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/playbooks/archive-playbook

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /playbooks/{playbookId}/archive:
    post:
      operationId: archive-playbook
      summary: Archive a playbook definition
      description: >-
        Transitions the playbook identified by `playbookId` to `archived`
        status, retiring it from active use. Authorization: organization
        administrators only — other callers are rejected with 403. No request
        body. Response: `{ data: Playbook }` with the updated status.
      tags:
        - playbooks
      parameters:
        - name: playbookId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The archived playbook definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookEnvelope'
servers:
  - url: https://api.cloudraker.com
    description: Production
  - url: https://api.staging.raker.one
    description: Staging
  - url: https://api.dev.raker.one
    description: Development
components:
  schemas:
    PlaybookStatus:
      type: string
      enum:
        - draft
        - active
        - archived
      title: PlaybookStatus
    PlaybookTasksItems:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        instructions:
          type:
            - string
            - 'null'
        dependsOn:
          type: array
          items:
            type: string
          description: Task ids that must complete first.
      required:
        - id
        - title
        - instructions
        - dependsOn
      title: PlaybookTasksItems
    PlaybookActionsItemsTrigger:
      type: string
      enum:
        - agent
        - user
      description: >-
        `user` actions are started from the run view; the agent never proposes
        them.
      title: PlaybookActionsItemsTrigger
    PlaybookActionsItems:
      type: object
      properties:
        installedActionId:
          type: string
        preApproval:
          type: boolean
          description: Gate the action behind a human approval.
        postApproval:
          type: boolean
          description: Review the action output before continuing.
        dependsOn:
          type: array
          items:
            type: string
          description: Task ids only — an action may never depend on another action.
        trigger:
          $ref: '#/components/schemas/PlaybookActionsItemsTrigger'
          description: >-
            `user` actions are started from the run view; the agent never
            proposes them.
      required:
        - installedActionId
        - preApproval
        - postApproval
        - dependsOn
        - trigger
      title: PlaybookActionsItems
    Playbook:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        status:
          $ref: '#/components/schemas/PlaybookStatus'
        spaceTypes:
          type: array
          items:
            type: string
          description: >-
            Space-type identifiers this playbook applies to. Empty means every
            space type.
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/PlaybookTasksItems'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/PlaybookActionsItems'
        version:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        createdBy:
          type: string
      required:
        - id
        - name
        - description
        - status
        - spaceTypes
        - tasks
        - actions
        - version
        - createdAt
        - updatedAt
        - createdBy
      title: Playbook
    PlaybookEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Playbook'
      required:
        - data
      title: PlaybookEnvelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "id": "pb-9f8e7d6c5b4a3",
    "name": "Contract intake",
    "description": "A playbook for managing the contract intake process from initial submission to approval.",
    "status": "archived",
    "spaceTypes": [
      "legal",
      "sales"
    ],
    "tasks": [
      {
        "id": "task-001",
        "title": "Review contract submission",
        "instructions": "Check the contract for completeness and compliance with company policies.",
        "dependsOn": []
      }
    ],
    "actions": [
      {
        "installedActionId": "action-approve-contract",
        "preApproval": true,
        "postApproval": true,
        "dependsOn": [
          "task-001"
        ],
        "trigger": "agent"
      }
    ],
    "version": 3,
    "createdAt": "2023-11-20T14:45:00Z",
    "updatedAt": "2024-04-10T11:20:00Z",
    "createdBy": "admin@cloudraker.com"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/playbooks/playbookId/archive"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/playbooks/playbookId/archive';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/playbooks/playbookId/archive"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/playbooks/playbookId/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/playbooks/playbookId/archive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/playbooks/playbookId/archive', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/playbooks/playbookId/archive");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/playbooks/playbookId/archive")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```