---
title: "Turn a brand guideline on or off. Guideline ids come from get_brand."
method: POST
path: "/api/v1/brand/guidelines/active"
---

# Turn a brand guideline on or off. Guideline ids come from get_brand.

`POST /api/v1/brand/guidelines/active`

## Request

- Base URL: `https://api.rctrl.com`
- URL: `https://api.rctrl.com/api/v1/brand/guidelines/active`
- Auth: HTTP bearer

Requires the `write:content` scope.

## Request body

- object
  - `guidelineId` string, required: Guideline id from get_brand
  - `on` boolean, required: true turns the guideline on, false turns it off

## Response `200`

Success; the payload is wrapped in a data envelope

- object
  - `data` unknown

## Other responses

- `400`: Bad input
- `401`: Missing or invalid API key
- `403`: API key lacks the required scope
- `404`: Not found in this workspace
- `429`: Rate limited; the body includes a retryAfterMs hint

---

[API](https://skmtc.dev/rctrl/apis/rankcontrol-api.md) · [All operations](https://skmtc.dev/rctrl/apis/rankcontrol-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rctrl/apis/rankcontrol-api/revisions/98ecd236394a?raw)