Delete a unit

​

By default the unit is only deleted when no other resources depend on it; if it has registrations or transcripts the request fails with 406 listing the dependencies. Passing force=true permanently deletes the unit and its dependent data — registrations, transcripts, and sessions — and removes references to it from study plans, budgets, profiles' roles, segments, automations, and applications. This is irreversible; call without force first to inspect dependencies.

Path Parameters
  • unit_id
    Type: string
    required

    Unique identifier of the unit.

Query Parameters
  • force
    Type: boolean

    When true, permanently deletes the unit even when registrations or transcripts depend on it, removing them together with the unit and its sessions.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for delete/apis/units/units/{unit_id}
curl https://school.fullfabric.cloud/apis/units/units/507f1f77bcf86cd799439011 \
  --request DELETE \
  --header 'FF-Auth: YOUR_SECRET_TOKEN'

{}

Unit deleted successfully. Returns an empty object.