---
title: "Update Lifecycles"
method: PUT
path: "/revenue/lifecycle"
tags: ["Revenue"]
---

# Update Lifecycles

`PUT /revenue/lifecycle`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/revenue/lifecycle`
- Auth: HTTP bearer

REPLACE the whole set of Revenue lifecycle stages.

Not a merge. The posted `entries` array becomes the config, so a stage left
out of it is DELETED along with the document defaults attached to it. Read
`GET /lifecycle-stages` first and send the full list back with your change
applied.

An entry with an empty `id` is treated as NEW and gets a fresh UUID. An
entry that keeps its id keeps its stage document defaults - those are
merged forward by id, not rebuilt.

## Headers

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

## Request body

- UpdateLifecyclesRequest: REPLACES the whole `entries` array. A stage left out is DELETED. This is a PUT in the app and a PUT here for that reason: it is not a merge. Read `GET /lifecycle-stages` first and send the full list back with your change applied.
  - `entries` LifecycleEntryRequest[], required
    - `id` string, required
    - `name` string, required
    - `slug` string, required
    - `status_match` string[]
    - `custom_status_match` string[]
    - `subscription_filter` string[], nullable
    - `icon` string
    - `sort_order` integer
    - `hidden` boolean
    - `auto_hide_if_empty` boolean
    - `description` string, nullable
    - `is_system_seed` boolean
    - `event_tracking` LifecycleEventTrackingRequest
      - `enabled` boolean
      - `events` LifecycleEventConfigRequest[]
        - `event_name` string, required
        - `display_name` string, required
        - `description` string, nullable
        - `bucket` string, required: activation | usage | expansion | risk | aha_moment
        - `weight` number, nullable
        - `path_to_paid_step` integer, nullable
    - `churn_reason_categories` string[], nullable

## Response `200`

Successful Response

- ApiResponseReportPayload
  - `data` ReportPayload, required: An OPEN envelope around one report's answer. The app wraps every one of these reports in `{success, data, meta}`, where `meta` carries the cache state, the window and - on the agency reports - `failed_org_ids`, the orgs that contributed NOTHING to the totals above. That field is the difference between "this client sent no email" and "we could not query this client", so it is forwarded rather than flattened away. Open on purpose: `data` is `dict | list` in the app and its contents grow with the product. A closed model would turn every new metric into a silently dropped one.
  - `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)