FansquareAPI reference
Open the app

AI control

Release AI locks in bulk

POST/v1/accounts/{account_id}/ai-locks/release

Releases the AI lock on each fan in the batch, in a single call. Fans that are not currently locked are ignored, so the count returned may be lower than the number of ids sent.

Required scopewrite:ai_locks
Rate limit120 requests per minute
curl -X POST 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/ai-locks/release' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "fan_ids": [
    "a6df8022-e509-4575-ad28-e29c2d1d42dc"
  ]
}'
{
  "released": 1
}

Parameters

Headers

  • Fansquare-Versionstringrequired

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

Path

  • account_idstringrequired

    MYM account id (account.external_id in GET /v1/creators).

    min length 1

Body

application/json

  • fan_idsarray of stringsrequired

    MYM fan ids. 1 to 500 per call; duplicates are ignored.

    format uuidmin items 1max items 500

Response

OK, application/json

  • releasedintegerrequired

    Number of locks actually removed (may be lower than the ids sent).

curl -X POST 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/ai-locks/release' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "fan_ids": [
    "a6df8022-e509-4575-ad28-e29c2d1d42dc"
  ]
}'
{
  "released": 1
}