---
title: "Create Stagegate Rule"
method: POST
path: "/stagegate/rules"
tags: ["Stagegate"]
---

# Create Stagegate Rule

`POST /stagegate/rules`

## Request

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

Create a rule. Admin only; `name` and `conditions` are required. An enabled rule is checked against open deals straight away (in the background).

## Headers

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

## Request body

- StagegateRuleRequest: A rule. For PATCH send only the fields to change; POST needs `name` and `conditions`.
  - `name` string, nullable
  - `conditions` object[], nullable: The rule logic; the app validates the condition types.
  - `how_to_fix` string, nullable
  - `quick_fix_kind` 'note' | 'task' | 'call' | 'meeting', nullable
  - `pipeline_ids` string[], nullable: Only deals in these pipelines; omit for all.
  - `enabled` boolean, nullable

## Response `201`

Successful Response

- ApiResponseStagegateRulesPayload
  - `data` StagegateRulesPayload, required: The organisation's rules (`items`, `can_edit`, `reconciled`) or one rule.
  - `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/89fc11143b70?raw)