Rename content — Brigg developers

Access & visibility

Allow documents.RenameBundle on your API key.

Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

content_idstringRequired

Use content_id and check kind before choosing the operation. An app, template, website and uploaded file are not interchangeable. workspace.ListBundles.

At least 1 character.

namestringOptional

New content display name. Omit to keep the name when changing only icon_slug.

At least 1 character. At most 80 characters.

icon_slugstring or nullOptional

A sidebar icon from the curated catalog; null resets it to the derived default.

Response

Returns 200 OK with a JSON body.

This changes the name or icon of content selected from ListBundles. It preserves content_id and does not copy, move or republish the content. The acting member must be allowed to administer it.

okbooleanRequired

Whether the action completed successfully.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

List bundles

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "content_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use content_id and check kind before choosing the operation. An app, template, website and uploaded file are not interchangeable. [workspace.ListBundles](/developers/reference/workspace/ListBundles)."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "New content display name. Omit to keep the name when changing only icon_slug."
    },
    "icon_slug": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "default",
            "home",
            "users",
            "shield",
            "trophy",
            "headphones",
            "briefcase",
            "award",
            "building",
            "scale",
            "rocket",
            "calendar",
            "checklist",
            "folder",
            "graph",
            "lightbulb",
            "money",
            "package",
            "phone",
            "puzzle",
            "star",
            "tag",
            "cloud",
            "globe",
            "clock",
            "receipt",
            "book",
            "chat",
            "funnel",
            "kanban",
            "ticket"
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "A sidebar icon from the curated catalog; null resets it to the derived default."
    }
  },
  "required": [
    "content_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "content_id": "c_vendor_portal",
      "name": "Supplier portal"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true
    }
  ]
}

Try the request

Use your API key in a server environment.

Requires BRIGG_ACT_AS: an approved member account ID.

Pass at least the name or icon you intend to change.

Request

cURL

curl 'https://api.brigg.app/v1/operations/documents.RenameBundle' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "content_id": "c_vendor_portal",
  "name": "Supplier portal"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/documents.RenameBundle", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "content_id": "c_vendor_portal",
    "name": "Supplier portal"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "content_id": "c_vendor_portal",
  "name": "Supplier portal"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.RenameBundle",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true
}

Illustrative values, not a live response.