Replace the tag

Embed

<a href="https://forumulate.com/reference/forumulate-api-blogtaxonomy-settag"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/3ffdd995-2091-4a39-80e7-a844e0790b15/social-card.svg?v=3e7ae33eec8b" alt="Replace the tag" width="600" height="315"></a>

PUThttps://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}

How one tag looks to readers — display name, colours, description, cover, and the scheme its pages wear. The path takes the stored SLUG; the label is what changes. Partial: a key left out keeps its value, null clears it.

Requires token scope: write (the coarse method gate) for Atlas key (ak_), Personal Access Token (cft_) or OAuth (cfo_) auth — in addition to any catalog scope (GET /pats/scopes) the route’s capability needs. Session/cookie auth is governed by RBAC capabilities instead.

Parameters

orgIdstringpathrequired

spaceIdstringpathrequired

slugstringpathrequired

forumulate-versionstringheader

API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:

Idempotency-Keystringheader

Makes this write safe to retry. Optional — send any unique string (a UUID is ideal) and the first request runs while its response is remembered under that key for 24 hours; an identical retry replays that same status and body instead of acting twice, so a timeout or a 5xx from the edge can be retried without creating a second row. A retry sent while the first request is still in flight is refused with 409. The key is scoped to the method and path, so the same key on a different endpoint is a different request. Error responses of 5xx are never cached — those retries re-run. A key is bound to the BODY it was first used with: reusing it with a different body is a 409 idempotency.key_reused, not a replay, because replaying would tell you a write landed that never ran. Generate one key per request, never per process or per session.

Request body application/json

labelstring

What readers see ("AI & ML" for ai-ml). The slug stays the id. null = the slug.

colorstring

Chip background: a hex value or a CSS colour name.

textColorstring

Chip text colour.

colorDarkstring

Chip background in a dark scheme. null = color in both schemes.

textColorDarkstring

Chip text colour in a dark scheme. null = textColor in both schemes.

gradientstring[]

Gradient ink through the tag’s words (the text and eyebrow looks, a card kicker): 2–3 #hex stops. null clears.

descriptionstring

Shown on the tag’s landing page and as its meta description.

pageSchemestring

The colour scheme the tag’s landing page and its posts wear; null = the space’s.

pagePaletteobject

Theme palette slots for those pages (primary, background, …).

Show child parameters

primarystring

secondarystring

tertiarystring

quaternarystring

header_backgroundstring

header_primarystring

highlightstring

dangerstring

successstring

lovestring

backgroundstring

surfacestring

inkstring

headingstring

mutedstring

linestring

footer_backgroundstring

footer_primarystring

infostring

warningstring

paperstring

warm | white | soft | grey

coverUrlstring

The image heading the tag’s landing page.

iconHeaderIconName | string

A glyph name (the theming guide lists them) or an image URL drawn before the tag’s label, on the blog and the forum. null = none.

{
  "label": "string",
  "color": "string",
  "textColor": "string",
  "colorDark": "string",
  "textColorDark": "string",
  "gradient": [
    "string"
  ],
  "description": "string",
  "pageScheme": "light",
  "pagePalette": {
    "primary": "string",
    "secondary": "string",
    "tertiary": "string",
    "quaternary": "string",
    "header_background": "string",
    "header_primary": "string",
    "highlight": "string",
    "danger": "string",
    "success": "string",
    "love": "string",
    "background": "string",
    "surface": "string",
    "ink": "string",
    "heading": "string",
    "muted": "string",
    "line": "string",
    "footer_background": "string",
    "footer_primary": "string",
    "info": "string",
    "warning": "string",
    "paper": "warm"
  },
  "coverUrl": "string",
  "icon": "book"
}

Code samples

cURL

curl -X PUT "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}" \
  -H "forumulate-version: <value>" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","color":"string","textColor":"string","colorDark":"string","textColorDark":"string","gradient":["string"],"description":"string","pageScheme":"light","pagePalette":{"primary":"string","secondary":"string","tertiary":"string","quaternary":"string","header_background":"string","header_primary":"string","highlight":"string","danger":"string","success":"string","love":"string","background":"string","surface":"string","ink":"string","heading":"string","muted":"string","line":"string","footer_background":"string","footer_primary":"string","info":"string","warning":"string","paper":"warm"},"coverUrl":"string","icon":"book"}'

TypeScript

const res = await fetch('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}', {
  method: 'PUT',
  headers: {
    'forumulate-version': '<value>',
    'Idempotency-Key': '<value>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"label":"string","color":"string","textColor":"string","colorDark":"string","textColorDark":"string","gradient":["string"],"description":"string","pageScheme":"light","pagePalette":{"primary":"string","secondary":"string","tertiary":"string","quaternary":"string","header_background":"string","header_primary":"string","highlight":"string","danger":"string","success":"string","love":"string","background":"string","surface":"string","ink":"string","heading":"string","muted":"string","line":"string","footer_background":"string","footer_primary":"string","info":"string","warning":"string","paper":"warm"},"coverUrl":"string","icon":"book"}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PUT",
    "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}",
    headers={
    "forumulate-version": "<value>",
    "Idempotency-Key": "<value>",
    "Content-Type": "application/json",
    },
    json={"label": "string", "color": "string", "textColor": "string", "colorDark": "string", "textColorDark": "string", "gradient": ["string"], "description": "string", "pageScheme": "light", "pagePalette": {"primary": "string", "secondary": "string", "tertiary": "string", "quaternary": "string", "header_background": "string", "header_primary": "string", "highlight": "string", "danger": "string", "success": "string", "love": "string", "background": "string", "surface": "string", "ink": "string", "heading": "string", "muted": "string", "line": "string", "footer_background": "string", "footer_primary": "string", "info": "string", "warning": "string", "paper": "warm"}, "coverUrl": "string", "icon": "book"},
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("PUT", "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}", strings.NewReader(`{"label":"string","color":"string","textColor":"string","colorDark":"string","textColorDark":"string","gradient":["string"],"description":"string","pageScheme":"light","pagePalette":{"primary":"string","secondary":"string","tertiary":"string","quaternary":"string","header_background":"string","header_primary":"string","highlight":"string","danger":"string","success":"string","love":"string","background":"string","surface":"string","ink":"string","heading":"string","muted":"string","line":"string","footer_background":"string","footer_primary":"string","info":"string","warning":"string","paper":"warm"},"coverUrl":"string","icon":"book"}`))
	req.Header.Set("forumulate-version", "<value>")
	req.Header.Set("Idempotency-Key", "<value>")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>', 'Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"label":"string","color":"string","textColor":"string","colorDark":"string","textColorDark":"string","gradient":["string"],"description":"string","pageScheme":"light","pagePalette":{"primary":"string","secondary":"string","tertiary":"string","quaternary":"string","header_background":"string","header_primary":"string","highlight":"string","danger":"string","success":"string","love":"string","background":"string","surface":"string","ink":"string","heading":"string","muted":"string","line":"string","footer_background":"string","footer_primary":"string","info":"string","warning":"string","paper":"warm"},"coverUrl":"string","icon":"book"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}')
req = Net::HTTP::Put.new(uri)
req['forumulate-version'] = '<value>'
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"label":"string","color":"string","textColor":"string","colorDark":"string","textColorDark":"string","gradient":["string"],"description":"string","pageScheme":"light","pagePalette":{"primary":"string","secondary":"string","tertiary":"string","quaternary":"string","header_background":"string","header_primary":"string","highlight":"string","danger":"string","success":"string","love":"string","background":"string","surface":"string","ink":"string","heading":"string","muted":"string","line":"string","footer_background":"string","footer_primary":"string","info":"string","warning":"string","paper":"warm"},"coverUrl":"string","icon":"book"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/blog/tags/{slug}"))
    .header("forumulate-version", "<value>")
    .header("Idempotency-Key", "<value>")
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"label\":\"string\",\"color\":\"string\",\"textColor\":\"string\",\"colorDark\":\"string\",\"textColorDark\":\"string\",\"gradient\":[\"string\"],\"description\":\"string\",\"pageScheme\":\"light\",\"pagePalette\":{\"primary\":\"string\",\"secondary\":\"string\",\"tertiary\":\"string\",\"quaternary\":\"string\",\"header_background\":\"string\",\"header_primary\":\"string\",\"highlight\":\"string\",\"danger\":\"string\",\"success\":\"string\",\"love\":\"string\",\"background\":\"string\",\"surface\":\"string\",\"ink\":\"string\",\"heading\":\"string\",\"muted\":\"string\",\"line\":\"string\",\"footer_background\":\"string\",\"footer_primary\":\"string\",\"info\":\"string\",\"warning\":\"string\",\"paper\":\"warm\"},\"coverUrl\":\"string\",\"icon\":\"book\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 Success.

Example

{
  "tag": {
    "color": "string",
    "colorDark": "string",
    "coverUrl": "string",
    "description": "string",
    "gradient": [
      "string"
    ],
    "icon": "string",
    "label": "string",
    "pagePalette": {},
    "pageScheme": "dark",
    "slug": "string",
    "textColor": "string",
    "textColorDark": "string"
  },
  "warnings": [
    "tags: \"Launch Day\" is stored as \"launch-day\""
  ]
}

Schema

tagobjectrequired

Show child parameters

colorstringrequired

colorDarkstringrequired

coverUrlstringrequired

descriptionstringrequired

gradientarrayrequired

iconstring

labelstringrequired

pagePaletteobjectrequired

pageSchemestringrequired

dark | light

slugstringrequired

textColorstringrequired

textColorDarkstringrequired

warningsstring[]

Values we ACCEPTED and then rewrote, one sentence each — a slugified tag, a normalised colour, a clamped range, a slug that was taken. Absent when nothing was rewritten, never []. The same sentences are on the X-Field-Warnings response header. If this is present, something you sent is not what is stored; read the resource back rather than assuming your own value.

400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.

reasonstring

Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.

requestIdstring

The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.

401 No credential, or one that is expired or revoked (auth.required). Send a Bearer token or the session cookie.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

403 Authenticated, and not allowed — always rbac.forbidden, whether what is missing is the capability, the token scope, or a resource the token is pinned away from. The message names the capability and, for a scope refusal, the scopes that would grant it. A refusal because of the PLAN is a 402 with quota.exceeded, not this.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (*.not_found).

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

422 The body was understood and a value is unacceptable (validation.failed). error.details names the field paths.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

429 Rate limited — see the RateLimit-* headers.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

default Error — the stable { error: { code, message } } envelope.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

The Forumulate teamUpdated Oct 17, 2026

Was this page helpful?