Activate account

Activate account

post

Activate account. Available for Operations account with platform account management permissions. Moves the account to Active state and sets the externalId from the request if sent. Returns the updated account object with audit.activated.

Path parameters

idstringRequired

Account identifier.

Body

application/jsontext/jsonapplication/*+json

idstringOptional

namestring · min: 1 · max: 500Required

iconstring · nullableOptional

revisioninteger · int32Optional

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

externalIdstring · min: 1 · max: 250Required

externalNamestring · nullableOptional

technicalSupportEmailstring · email · max: 320 · nullableOptional

websitestring · max: 2000 · nullableOptional

descriptionstring · max: 2000 · nullableOptional

defaultLanguageCodestring · nullableOptional

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}/activate

HTTPcURLJavaScriptPython

POST /public/v1/accounts/accounts/{id}/activate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "externalId": "WW-CON-123456"
}

application/jsontext/jsonapplication/*+json

{
  "id": "ACC-1234-1234",
  "revision": 2,
  "name": "Contoso Ltd",
  "status": "Active",
  "externalId": "WW-CON-123456",
  "audit": {
    "created": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "updated": {
      "at": "2024-02-02T10:10:00+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "activated": {
      "at": "2024-02-02T10:10:00+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    }
  }
}