Disable Licensee

Disable the licensee object.

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/licensees/{id}/disable HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-21T18:11:12.178Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-21T18:11:12.178Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "disabled": {
      "at": "2025-06-21T18:11:12.178Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "icon": "text",
  "contact": {
    "name": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "[email protected]",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "user": {
      "id": "text",
      "audit": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2025-06-21T18:11:12.178Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "icon": "text",
          "type": "text",
          "status": "text",
          "name": "text"
        }
      ],
      "currentAccount": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      }
    }
  },
  "name": "text",
  "externalId": "text",
  "status": "text",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "useBuyerAddress": true,
  "description": "text",
  "account": {
    "id": "text",
    "icon": "text",
    "type": "text",
    "status": "text",
    "name": "text"
  },
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text"
  },
  "eligibility": {
    "client": true,
    "partner": true
  }
}