Skip to main content

Update admin profile

PUT 
/v2/onboard/admin

Updates the profile of the admin that owns the access token, for example the name or the phone number.

Request​

Body

required
    organisationAdmin objectrequired

    The profile fields to update.

    id string
    email string

    Email

    name stringrequired

    Name

    avatarImageId string

    Avatar image ID

    avatarImageUrl string

    Avatar image Url

    lastVisited string

    Last visited date time

    roleId integer

    Role ID

    roleName string

    Role name

    phone string

    Admin's phone number

    imageId string

    Unique identifier for the admin's image

    imageUrl string

    URL to the admin's image

    externalId string

    External identifier for the admin

    identityProviderId string

    Identity provider ID

    organizationId string

    Unique identifier for the organization

    organizationName string

    Name of the organization

Responses​

The service updated the profile of the admin.

Schema
    organisationAdmin object
    id string
    email string

    Email

    name stringrequired

    Name

    avatarImageId string

    Avatar image ID

    avatarImageUrl string

    Avatar image Url

    lastVisited string

    Last visited date time

    roleId integer

    Role ID

    roleName string

    Role name

    phone string

    Admin's phone number

    imageId string

    Unique identifier for the admin's image

    imageUrl string

    URL to the admin's image

    externalId string

    External identifier for the admin

    identityProviderId string

    Identity provider ID

    organizationId string

    Unique identifier for the organization

    organizationName string

    Name of the organization

Loading...
Last updated on