Disable account

Disable account

post

Disable an active account. Access: Authenticated account with platform account management permissions. Moves the account to the Disabled state. Returns the updated account object.

Path parameters

idstringRequired

Account identifier.

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

externalIdstring · nullableOptional

externalNamestring · nullableOptional

technicalSupportEmailstring · nullableOptional

websitestring · nullableOptional

descriptionstring · nullableOptional

defaultLanguageCodestring · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

post/public/v1/accounts/accounts/{id}/disable

HTTPcURLJavaScriptPython

POST /public/v1/accounts/accounts/{id}/disable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "ACC-1234-1234",
  "revision": 2,
  "name": "Contoso Ltd",
  "status": "Disabled",
  "type": "Vendor",
  "audit": {
    "created": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "updated": {
      "at": "2024-02-02T10:05:00+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "disabled": {
      "at": "2024-02-02T10:05:00+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    }
  }
}