Update Account User

Beta

PATCH/v1/identity/account-users/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an account user.

Omitted fields are left unchanged. Profile fields (name, email, username) update the underlying user, which is shared across every account the user belongs to.

idstring

Account user ID.

include[]optional arrayenumValues:userroledepartment

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

User display name.

emailoptional string

User email address.

Must not already be in use by another user.

usernameoptional string

Unique username.

3–255 characters; letters, numbers, underscores, and hyphens. Must not already be in use by another user.

role_idoptional stringnullable

ID of the role to assign to the user.

Set to null to clear the role. Send null to clear.

department_idoptional stringnullable

ID of the department to assign to the user.

Set to null to clear the department. Send null to clear.

preferencesoptional array of object

Notification preference toggles to apply.

Only allowed when updating a user in another account you manage (cross-account); rejected otherwise. Notification types omitted from the list are left unchanged.

notification_typestringenumValues:invoiceorder_acknowledgementpurchase_order_submission

Notification type.

enabledboolean

Whether this notification type is enabled for the account user.

idstring

Account user ID.

userobjectExpandablenullable

Underlying user.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

User's full display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

URL of the user's profile image.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

active: the user can access the account.
disabled: the user is locked out of the account.
removed: the user has been removed (soft-deleted) from the account.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerobjectnullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

Always returned as null in this endpoint.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentobjectExpandablenullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationobjectnullable

The storage location where this department operates.

Always returned as null in this endpoint.

scanning_stationsobjectnullable

Scanning stations in this department.

Always returned as null in this endpoint.

machinesobjectnullable

Machines in this department.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

Responses

200

Successful response for Update Account User

Update Account User

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountUser = await client.identity.accountUsers.update('acus_01ea9983ddb41dacc44ecf997c', {
  department_id: 'dp_01791c25ab59da4704cba61874',
  name: 'John Doe',
  role_id: 'rl_01c16d2eb637c0d1f3a372937c',
});

console.log(accountUser.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountUser = await client.identity.accountUsers.update('acus_01ea9983ddb41dacc44ecf997c', {
  department_id: 'dp_01791c25ab59da4704cba61874',
  name: 'John Doe',
  role_id: 'rl_01c16d2eb637c0d1f3a372937c',
});

console.log(accountUser.id);

200 example

{
  "id": "acus_01ea9983ddb41dacc44ecf997c",
  "user": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "user",
    "email": "jdoe@augno.com",
    "name": "John Doe",
    "username": "jdoe",
    "email_verified_at": "2026-06-10T00:00:00Z",
    "image_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "object": "account_user",
  "status": "active",
  "role": {
    "id": "rl_01c16d2eb637c0d1f3a372937c",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": null,
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "department": null,
  "last_used_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acus_01ea9983ddb41dacc44ecf997c",
  "user": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "user",
    "email": "jdoe@augno.com",
    "name": "John Doe",
    "username": "jdoe",
    "email_verified_at": "2026-06-10T00:00:00Z",
    "image_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "object": "account_user",
  "status": "active",
  "role": {
    "id": "rl_01c16d2eb637c0d1f3a372937c",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": null,
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "department": null,
  "last_used_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Account User

Path Parameters

Query Parameters

Request Body

Returns

Responses