Scripts

Delete a script collection

DELETE/v1/script-collections/{collection_id}

Deletes a collection AND every script in it, for good. The sequence options that pointed to those scripts stay, without a script, until they are replaced. Past sends keep their history. Confirm with the user first.

Required scopewrite:scripts

Rate limit30 requests per minute

curl -X DELETE 'https://api.fansquare.so/v1/script-collections/9b0b4f0e-3127-406b-a0f2-e7bf80e50779' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "type": "https://developers.offmy.co/errors/validation_failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "limit: Number must be less than or equal to 200",
  "instance": "/v1/script-collections/12345",
  "errors": [
    {
      "keyword": "invalid_string",
      "instancePath": "/collection_id",
      "schemaPath": "#/collection_id/invalid_string",
      "params": {
        "issue": {
          "code": "invalid_string",
          "validation": "uuid",
          "path": [
            "collection_id"
          ],
          "message": "Invalid uuid"
        }
      },
      "message": "Invalid uuid",
      "path": "collection_id"
    }
  ]
}

Parameters

Headers

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

Path

collection_idstringrequired
Fansquare script collection id (the id field of collection items).
format uuid

Response

No content

No response body

curl -X DELETE 'https://api.fansquare.so/v1/script-collections/9b0b4f0e-3127-406b-a0f2-e7bf80e50779' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "type": "https://developers.offmy.co/errors/validation_failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "limit: Number must be less than or equal to 200",
  "instance": "/v1/script-collections/12345",
  "errors": [
    {
      "keyword": "invalid_string",
      "instancePath": "/collection_id",
      "schemaPath": "#/collection_id/invalid_string",
      "params": {
        "issue": {
          "code": "invalid_string",
          "validation": "uuid",
          "path": [
            "collection_id"
          ],
          "message": "Invalid uuid"
        }
      },
      "message": "Invalid uuid",
      "path": "collection_id"
    }
  ]
}