Scripts

Create a script collection

POST/v1/script-collections

Creates an empty collection for a creator, placed last. Add scripts to it with POST /v1/scripts.

Required scopewrite:scripts

Rate limit30 requests per minute

curl -X POST 'https://api.fansquare.so/v1/script-collections' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "creator_id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "description": "string"
}'

{
  "id": "40a6e358-bd2a-4cff-a59e-5709874d3f5b",
  "creator_id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "description": "string",
  "position": 1,
  "script_count": 12,
  "created_at": "2026-10-12T21:14:00.000Z",
  "updated_at": "2026-10-12T21:14:00.000Z"
}

Parameters

Headers

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

Body

application/json

creator_idstringrequired
Fansquare creator id (see GET /v1/creators).
min length 1
namestringrequired
Name of the collection (1 to 22 characters).
min length 1max length 22
descriptionstring
Description of the collection (200 characters max).
max length 200

Response

Created, application/json

idstringrequired
Fansquare script collection id. Path parameter of the /v1/script-collections/{collection_id} routes.
creator_idstringrequired
Fansquare creator id (see GET /v1/creators).
namestringrequired
Name of the collection, as shown in the Scripts page of the app.
descriptionstringrequired
Description of the collection. Empty when there is none.
positionintegerrequired
Order of the collection among those of its creator (0 first), as the app shows them.
script_countintegerrequired
Number of scripts in the collection.
created_atstringrequired
When the collection was created (ISO 8601).
format date-time
updated_atstringrequired
When the collection was last changed (ISO 8601).
format date-time

curl -X POST 'https://api.fansquare.so/v1/script-collections' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "creator_id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "description": "string"
}'

{
  "id": "40a6e358-bd2a-4cff-a59e-5709874d3f5b",
  "creator_id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "description": "string",
  "position": 1,
  "script_count": 12,
  "created_at": "2026-10-12T21:14:00.000Z",
  "updated_at": "2026-10-12T21:14:00.000Z"
}