Disable Account

Disable the Account object. Disabling prevents users from signing in.

post

Path parameters

idstringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

HTTPcURLJavaScriptPython

POST /public/v1/accounts/accounts/{id}/disable HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-01T19:11:50.370Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-06-01T19:11:50.370Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "icon": "text",
  "externalIds": {
    "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "externalId": "text",
  "externalName": "text",
  "type": "text",
  "status": "text",
  "serviceLevel": "text",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "technicalSupportEmail": "[e-mail]",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "eligibility": {
    "client": true,
    "partner": true
  }
}