Sign in
System Accounts

Update System Account

Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization.

patch/v3/system-accounts/{accountId}

Request body

namestring

Name of the system account.

descriptionstring

Description of the system account.

Response

A response including a single system account.

idstring uuid

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring date-time

Timestamp of when the system account was created.

updated_atstring date-time

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Example System Account",
  "description": "This is a sample system account description.",
  "created_at": "2022-08-24T14:15:22Z",
  "updated_at": "2022-10-05T10:33:49Z",
  "konnect_managed": false
}

Changes

Changed in 2 of the 75 revisions of this API.92

  • 845120e19d452See the full diff
    • ▲

      the request property description became not nullable

      request-property-became-not-nullable

    • ▲

      the request property name became not nullable

      request-property-became-not-nullable

  • 3c0154b2053a72See the full diff
    • ▲

      the response property description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 403

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 403

      response-property-became-nullable

    • ▲

      the response property konnect_managed became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 403

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 403

      response-property-became-nullable

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property name became nullable

      request-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog