---
title: Archive guide
description: "Archives an unpublished guide. A guide counts as published while its flag is enabled, unless it's only in test mode without a schedule; archiving a published…"
product: general
lang: en
last_updated: 2026-10-27
token_estimate: 1182
---
# Archive guide

> For AI agents: a documentation index is available at [/docs/llms.txt](/docs/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## Archive guide

**DELETE** `/v1/projects/{project_id}/guides/{guide_id}`

Full URL: `https://developer-api.amplitude.com/v1/projects/{project_id}/guides/{guide_id}`

**Servers:**
- Production (US): `https://developer-api.amplitude.com/v1/projects/{project_id}/guides/{guide_id}`
- Production (EU): `https://developer-api.eu.amplitude.com/v1/projects/{project_id}/guides/{guide_id}`

Archive guide

Archives an unpublished guide. A guide counts as published while its flag is
enabled, unless it's only in test mode without a schedule; archiving a
published guide returns `409` with `error_code: cannot_archive_published`.
Unpublish it in Amplitude first. Use `dry_run=true` to check whether a guide
can be archived. An already archived guide returns `404`, like `GET`.

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Authorization | string | Yes | — | http |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| project_id (path) | string | Yes | 12345 | Amplitude project identifier, backed by the canonical app ID. Constraints: pattern: ^[0-9]+$ |
| guide_id (path) | string | Yes | — | Guide (tour nudge) identifier. Constraints: pattern: ^[0-9]+$ |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| dry_run (query) | boolean | No | false | Validate request without performing mutation. |

## Header parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Idempotency-Key (header) | string | Yes | — | Required on write operations. Keys aren't stored yet, so retrying a write with the same key performs it again; a retried create makes another resource. Check whether the first attempt succeeded before you retry. Constraints: min length: 8, max length: 255 |

## Response (application/json)

**204** — Guide archived, or with `dry_run=true`, the guide can be archived.

**400**

**401**

**403**

**404**

**409**

**429**

**500**

## Code samples

### cURL

```bash
curl -X DELETE "https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.delete(
    "https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false",
    headers={
        "Content-Type": "application/json",
        "Authorization": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false", {
  method: "DELETE",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("DELETE", "https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false"))
      .method("DELETE", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("Authorization", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://developer-api.amplitude.com/v1/projects/12345/guides/{guide_id}?dry_run=false")
request = Net::HTTP::Delete.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```