Skip to main content
User Management

Update admin profile

PUT/v4/onboard/platform/admin

Changes the display name of the admin who makes the call. organisationAdmin.name is required and is the only field that changes; a name of only spaces changes nothing. The service accepts the members id, email, avatarImageId, avatarImageUrl, lastSignIn, roleId and roleName and ignores them. Another member gets 400, also a member of Read admin profile that is not in this list, such as phone.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:admin-profile:update

Body

application/json
  • organisationAdminobjectrequired

    The new profile of the admin.

Response

application/json

The profile of the admin after the change.

  • organisationAdminobject

    The profile of the admin after the change.