---
title: "Archive Step Template"
method: PATCH
path: "/sequencer/templates/steps/{step_template_id}/archive"
tags: ["Sequences"]
---

# Archive Step Template

`PATCH /sequencer/templates/steps/{step_template_id}/archive`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/sequencer/templates/steps/{step_template_id}/archive`
- Auth: HTTP bearer

Archive or un-archive a step template (`is_archived` is explicit).

## Path parameters

- `step_template_id` string, required: Step template id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ArchiveRequest: Archive or UN-archive. An explicit flag rather than a toggle, so a retried request is idempotent instead of flipping the state back - and it is what makes the same route the un-archive route.
  - `is_archived` boolean, required

## Response `200`

Successful Response

- ApiResponseSequencerPayload
  - `data` SequencerPayload, required: An open envelope around one sequencer record. Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)