Scripts

Delete a script

DELETE/v1/scripts/{script_id}

Deletes a script and all its messages, for good. The sequence options that pointed to it 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/scripts/7668136a-d6ea-4b9d-a45d-f8b902de321f' \
  -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/scripts/12345",
  "errors": [
    {
      "keyword": "invalid_string",
      "instancePath": "/script_id",
      "schemaPath": "#/script_id/invalid_string",
      "params": {
        "issue": {
          "code": "invalid_string",
          "validation": "uuid",
          "path": [
            "script_id"
          ],
          "message": "Invalid uuid"
        }
      },
      "message": "Invalid uuid",
      "path": "script_id"
    }
  ]
}

Parameters

Headers

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

Path

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

Response

No content

No response body

curl -X DELETE 'https://api.fansquare.so/v1/scripts/7668136a-d6ea-4b9d-a45d-f8b902de321f' \
  -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/scripts/12345",
  "errors": [
    {
      "keyword": "invalid_string",
      "instancePath": "/script_id",
      "schemaPath": "#/script_id/invalid_string",
      "params": {
        "issue": {
          "code": "invalid_string",
          "validation": "uuid",
          "path": [
            "script_id"
          ],
          "message": "Invalid uuid"
        }
      },
      "message": "Invalid uuid",
      "path": "script_id"
    }
  ]
}