Block user

Block user

post

Blocks a user and prevents access. Returns the updated user object.

Path parameters

uniqueFilterstringRequired

User identifier (USR-...) or user email address.

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

emailstringOptional

statusstringOptional

firstNamestringOptional

lastNamestringOptional

lastLoginAtstring · date-time · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

post/public/v1/accounts/users/{uniqueFilter}/block

HTTPcURLJavaScriptPython

POST /public/v1/accounts/users/{uniqueFilter}/block HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-15T19:19:25.637Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-15T19:19:25.637Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-07-15T19:19:25.637Z"
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "email": "text",
  "status": "text",
  "phone": {
    "prefix": "text",
    "number": "text"
  },
  "firstName": "text",
  "lastName": "text",
  "lastLoginAt": "2026-07-15T19:19:25.637Z",
  "settings": {
    "cultureCode": "text",
    "dateFormat": "text",
    "languageCode": "text",
    "numberFormat": {
      "decimalSeparator": "text",
      "groupSeparator": "text"
    },
    "timeFormat": "text",
    "timeZone": "text",
    "optOuts": {
      "objectTypes": [
        "text"
      ]
    }
  },
  "accounts": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active"
    }
  ],
  "currentAccount": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  }
}