Fans

Create a fan tag

POST/v1/tags

Adds a tag at the end of the agency catalog, as Configuration does in Fansquare. Tags are agency-level: the creator scope of the key does not apply.

Required scopewrite:tags

Rate limit20 requests per minute

curl -X POST 'https://api.fansquare.so/v1/tags' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP",
  "color": "#FFD900"
}'

{
  "id": "58368a92-838b-4cb0-ab37-d54ce826ea11",
  "name": "VIP",
  "color": "#FFD900"
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Body

application/json

namestringrequired
Tag label, as shown on the fan card. Must contain at least one letter or digit.
min length 1max length 100
colorstringrequired
CSS color string, as Fansquare stores it (e.g. rgba(0, 112, 224, 0.5) or #C9A227).
min length 1max length 50

Response

Created, application/json

idstringrequired
Fansquare tag id, referenced by tags[].id on fans and by the tag_ids filter.
namestringrequired
Tag label, as shown on the fan card in Fansquare.
colorstring | nullrequired
Tag color configured in Fansquare (CSS color string), or null.

curl -X POST 'https://api.fansquare.so/v1/tags' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP",
  "color": "#FFD900"
}'

{
  "id": "58368a92-838b-4cb0-ab37-d54ce826ea11",
  "name": "VIP",
  "color": "#FFD900"
}