Users

Delete a specific user with dependencies

Deletes the user and dependencies. When only_orders_and_enrollments is true, deletes only orders, enrollments, payments, bulk invitations, and applicants — not the user or related account admins.

delete/api/v1/users/{id}

Request

  • Base URL
    https://catalog.example.edu
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Catalog user id

Query parameters

only_orders_and_enrollmentsboolean

Delete only user dependencies, not the user itself

Response

user (and/or dependencies) deleted

Changes

No recorded changes to this operation across all 1 revision of this API.