Reset Workspace

Reset Workspace on the Account

Reset Your Workspace Sandbox

This method is only available on Sandbox Workspaces

Reset the sandbox on this workspace

POST https://connect.getseam.com/workspaces/reset_sandbox

Resetting a Sandbox Workspace clears all the accounts and devices on the Workspace

Headers

Name	Type	Description
Authorization*	String	Bearer <API_KEY>

200: OK Workspace successfully reset

{
  "message": "Successfully reset workspace sandbox",
  "ok": true
}

400: Bad Request Workspace is not a Sandbox

{
    "type": "workspace_not_sandbox",
    "message": "can only reset sandbox on sandbox workspaces",
}

Code Example

Python

seam.workspaces.reset_sandbox()

# None

Javascript

await seam.workspaces.resetSandbox()

// { message: 'Successfully reset workspace sandbox', ok: true }

Ruby

seam.workspaces.reset_sandbox

# {"message"=>"Successfully reset workspace sandbox", "ok"=>true}

Parameters

This method doesn't take any parameters.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "message": "Successfully reset workspace sandbox",
  "ok": true
}