Update API token

Updates the specific token object.

Update API token

put

Update API token. Available for all account types (Operations account, Client account, Vendor account). Accepts a delta payload with fields to update (e.g. name, description, icon, modules). Returns the updated API token object.

Path parameters

idstringRequired

API token identifier.

Body

application/jsontext/jsonapplication/*+json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

statusstringOptional

descriptionstring · nullableOptional

lastAccessAtstring · date-time · nullableOptional

tokenstringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/public/v1/accounts/api-tokens/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "Robot Updated",
  "description": "Updated description",
  "modules": [
    {
      "id": "MOD-1756-1452"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "TKN-4134-7330",
  "revision": 2,
  "name": "Robot Updated",
  "description": "Updated description",
  "status": "Active",
  "account": {
    "id": "ACC-1234-5678",
    "name": "Microsoft"
  },
  "modules": [
    {
      "id": "MOD-1756-1452"
    }
  ],
  "audit": {
    "created": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "updated": {
      "at": "2024-02-02T10:00:00+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    }
  }
}