Validate Account

Validate the Account object.

post

Path parameters

idstringrequired

Body

application/jsontext/jsonapplication/*+json

idstringoptional

auditobjectoptional

$metaobjectoptional

hrefstringread-onlyoptional

externalIdsobjectoptional

externalIdstring | nullableoptional

externalNamestring | nullableoptional

typestring · enumoptional

Available options:

statusstring · enumoptional

Available options:

serviceLevelstring · enumoptional

Available options:

addressobjectoptional

iconstring | nullableread-onlyoptional

technicalSupportEmailstring | nullableoptional

websitestring | nullableoptional

descriptionstring | nullableoptional

namestring | nullableoptional

groupsobject[] | nullableoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/validate' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-04-01T21:40:22.567Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-04-01T21:40:22.567Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "description": "text",
        "account": "[Circular Reference]",
        "modules": "[Circular Reference]",
        "logo": "text",
        "isDefault": true,
        "users": "[Circular Reference]",
        "buyers": "[Circular Reference]"
      }
    ]
  }'

application/jsontext/jsonapplication/*+json

200

400

200

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-04-01T21:40:22.567Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-04-01T21:40:22.567Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "externalIds": {
    "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "externalId": "text",
  "externalName": "text",
  "type": "Client",
  "status": "Active",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "icon": "text",
  "technicalSupportEmail": "[e-mail]",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "name": "text",
      "description": "text",
      "account": "[Circular Reference]",
      "modules": "[Circular Reference]",
      "logo": "text",
      "isDefault": true,
      "users": "[Circular Reference]",
      "buyers": "[Circular Reference]"
    }
  ]
}

OK