Deactivate Account

This API can be used to deactivate an account using its metallic id. The API gives an option to disable login or backup or restore. At least one of the deactivation options must be set to true. The account deactivation process is asynchronous. The account status becomes deactivating when account deactivation process is initiated. Once deactivation is complete account status is deactivated.

Path Variables

Field	Description	Type	Notes
accountId	Account metallic id	UUID

Request Body

Field	Description	Type	Required
disableLogin	Login disabled when set to true	Boolean	False
disableBackup	Backup disabled when set to true	Boolean	False
disableRestore	Restore disabled when set to true	Boolean	False

At least one of the disable options must be set to true.

Response Body

Same as 'Get Account by Id - Response Body (Account Object)'

Path Parameters

id string required

text/plain

Request Body required

disableLogin boolean
disableBackup boolean
disableRestore boolean

Responses

application/json

Schema
Deactivate Account - Success

Schema

{
  "data": {
    "id": "7194af6f-1285-4295-94aa-ceed7ea2d792",
    "status": "deactivating",
    "insertTs": "2021-06-07T21:16:48",
    "updateTs": "2021-06-07T21:16:48",
    "externalId": "XSP1234",
    "name": "Acme ltd",
    "website": "www.acme.com",
    "provisionCountry": "United States",
    "contacts": [
      {
        "type": "admin",
        "email": "tada@acme.com",
        "firstName": "Tada",
        "lastName": "Wu",
        "phone": "+1 302 000 2020",
        "address": {
          "addressLine1": "1 Ave",
          "addressLine2": "Suite 204",
          "city": "Sunnyvale",
          "state": "California",
          "country": "United States",
          "postalCode": "94086"
        }
      }
    ],
    "type": "Production"
  }
}