SCscanopy
Organizations
internal

Reset organization data

Changed on

Deletes every entity except the organization and its owner.

post/api/v1/organizations/{id}/reset

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/organizations/{id}/reset
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Organization ID

Response

Organization reset

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • 51af15be596eRevision changes
    • breaking

      the //// response's property type changed from no type to object for status