Rename alignment category

Renames an alignment category. The slug is re-derived from the new name.

This is a rename only — description is not editable here. The app itself does not offer editing a category’s description after creation, so this endpoint does not either.

Requires the write:alignment scope, and the workspace must be enabled for API writes.


PATCH /v1/brands/{brand_id}/alignment/categories/{category_id}

Authorization

Header	Type	Required
`Authorization`	`Bearer asky_sk_…`	required
`Idempotency-Key`	`string`	required

Path parameters

Parameter	Type	Required	Description
`brand_id`	`uuid`	required	From List brands
`category_id`	`uuid`	required	From List alignment categories

Body

application/json

Field	Type	Required	Description
`name`	`string`, 1-100 chars	required	Its derived slug must be unique in the brand

Request

cURL


curl --request PATCH \
  --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/alignment/categories/8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Idempotency-Key: 5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Pricing and billing"}'

Python


import requests
 
url = "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/alignment/categories/8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65"
 
headers = {
    "Authorization": "Bearer <api-key>",
    "Idempotency-Key": "5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa",
    "Content-Type": "application/json",
}
payload = {"name": "Pricing and billing"}
 
response = requests.patch(url, json=payload, headers=headers)
print(response.text)

JavaScript


const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <api-key>',
    'Idempotency-Key': '5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({name: 'Pricing and billing'}),
};
 
fetch('https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/alignment/categories/8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP


<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/alignment/categories/8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode(["name" => "Pricing and billing"]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <api-key>",
    "Idempotency-Key: 5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa",
    "Content-Type: application/json"
  ],
]);
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go


package main
 
import (
    "fmt"
    "net/http"
    "strings"
    "io"
)
 
func main() {
 
    url := "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/alignment/categories/8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65"
 
    payload := strings.NewReader(`{"name": "Pricing and billing"}`)
 
    req, _ := http.NewRequest("PATCH", url, payload)
 
    req.Header.Add("Authorization", "Bearer <api-key>")
    req.Header.Add("Idempotency-Key", "5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa")
    req.Header.Add("Content-Type", "application/json")
 
    res, _ := http.DefaultClient.Do(req)
 
    defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)
 
    fmt.Println(string(body))
 
}

Ruby


require 'uri'
require 'net/http'
require 'json'
 
url = URI("https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/alignment/categories/8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65")
 
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
 
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <api-key>'
request["Idempotency-Key"] = '5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa'
request["Content-Type"] = 'application/json'
request.body = {name: "Pricing and billing"}.to_json
 
response = http.request(request)
puts response.read_body

Response

200


{
  "data": {
    "category": {
      "id": "8f3d2c1b-6a94-4e57-9c02-1b7f4d3a8e65",
      "name": "Pricing and billing",
      "slug": "pricing-and-billing",
      "description": "Claims about cost, plans and billing.",
      "sort_order": 0,
      "is_system": false
    }
  },
  "request_id": "req_7d21b0af59c34e18b6ac"
}

400


{
  "error": {
    "code": "invalid_request",
    "message": "Invalid input for asky_alignment_category_update: name: name cannot exceed 100 characters",
    "request_id": "req_2d61f0ac48b34e59c7bd"
  }
}

403 plan


{
  "error": {
    "code": "plan_required",
    "message": "This workspace is not enabled for API writes. Contact support to have it turned on.",
    "request_id": "req_9d4a7c1e3b5f48d0ac2e"
  }
}

404


{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "request_id": "req_5b0e77d213a94f6a8ce1"
  }
}

409


{
  "error": {
    "code": "conflict",
    "message": "This brand already has a category with that name.",
    "request_id": "req_4c81a0be29d34f1a6b72"
  }
}

Response fields

The category after the change, in a shape close to what List alignment categories returns — but see Notes.

Field	Type	Description
`data.category.id`	`uuid`	required
`data.category.name`	`string`	required
`data.category.slug`	`string`	required. Re-derived from the new name
`data.category.description`	`string \| null`	required. Unchanged — not editable here
`data.category.sort_order`	`integer`	required
`data.category.is_system`	`boolean`	required
`request_id`	`string`	required. Also returned as the `x-request-id` header. Quote it when contacting support

Errors

Status	Code	When
400	`invalid_request`	Unknown field, missing `name`, or `name` empty / over 100 characters
401	`invalid_token`	The key is missing, malformed, or does not exist
401	`token_expired`	The key passed its expiry date
401	`token_revoked`	The key was revoked
403	`insufficient_scope`	The key does not carry `write:alignment`
403	`plan_required`	This workspace is not enabled for API writes
404	`not_found`	The brand does not exist, this key is not allowed to reach it, or `category_id` does not belong to this brand
409	`conflict`	Another category in this brand already has that name
429	`rate_limited`	Over 60 requests per minute

Notes

active_prompt_count is not returned here. Unlike Create alignment category and List alignment categories, the response object has no active_prompt_count field — a rename does not change which prompts are assigned, so re-fetch List alignment categories if you need the current count.

description cannot be changed here. It is set only at creation time with Create alignment category and is returned unchanged.

Renaming does not move prompts or claims. Everything already assigned to this category stays assigned to it — only name and the derived slug change.

Idempotency-Key is required. See Idempotency.