v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

My Account

Update my account

patch/accounts/my-account

Headers

organizationstring required

The URL of the end-user web application

Request body

display_namestring

Display Name

usernamestring

Username

first_namestring

First Name

last_namestring

Last Name

emailstring

Contact email address

rolesstring[]

An array of role IDs

Example request

{
  "display_name": "John Doe",
  "username": "johndoe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "johndoe@fanhero.com",
  "roles": [
    "627ae0b32b26fd907fe32378",
    "627ae0b32b26fd907fe32379"
  ]
}

Response

Account updated

idstring

Account ID

display_namestring

Display Name

usernamestring

Username

first_namestring

First Name

last_namestring

Last name

emailstring

Contact email address

organizationstring

Organization ID

channelsObjectId[]

Channels

is_adminboolean

Admin account

is_tenant_userboolean

The account is the owner of the organization

is_super_userboolean

Super user

Example response

{
  "display_name": "John Doe",
  "username": "johndoe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "John",
  "organization": "698kow9a3efc39a89a96l9wf",
  "roles": [
    [
      {
        "permissions": [
          {
            "subject": {
              "id": "896632c05f1a59b6d395b963",
              "fields": [
                "name",
                "address"
              ],
              "entity": "accountstatuses"
            }
          }
        ],
        "name": "DEFAULT-USER",
        "description": "This role allows user basic functionalities",
        "default": true
      }
    ]
  ],
  "is_admin": true,
  "is_tenant_user": true,
  "is_super_user": true
}