Update Account User

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

Idempotent with Idempotency-Key header. Learn more

Partially updates an account user.

idstring

Account user ID.

nameoptional string

Display name.

emailoptional string

Email address.

usernameoptional string

Username.

role_idoptional stringnullable

Role ID. Send null to clear.

department_idoptional stringnullable

Department ID. Send null to clear.

preferencesarray of object

Notification preferences to toggle (external targets only).

notification_type_codestringenumValues:invoiceorder_acknowledgementpurchase_order_submission

Notification type code. Must match a value of constants.AccountRelationNotificationType.

enabledboolean

Whether this notification type is enabled for the account user.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

namestringnullable

Display name.

emailstringnullable

Email address.

usernamestringnullable

Username.

image_urlstringnullable

Profile image URL.

statusstringenumValues:activedisabledremoved

Account user status.

roleobjectnullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

ownerobjectnullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectnullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressobjectnullable

Default shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingobjectnullable

Branding configuration.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL (S3 key).

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalobjectnullable

Portal configuration.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

Portal slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentobjectnullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectnullable

Child locations. Expandable.

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

dataarray of object

Array of Location resources in this page

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectnullable

Child locations. Expandable.

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of Location resources in this page

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectnullable

Child locations. Expandable.

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of Location resources in this page

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectnullable

Child locations. Expandable.

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

dataarray of object

Array of Location resources in this page

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationsobjectnullable

Scanning stations in this department.

objectstringenumValues:list

Object type for ScanningStation list

page_infoobject

Pagination metadata for ScanningStation list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of ScanningStation resources in this page

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type.

label_sizestringnullableenumValues:1x11x31x4

Label size code.

label_typestringnullableenumValues:tagtraveler

Label type code.

material_check_requiredboolean

Whether material check is required.

departmentobjectnullable

Department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationsobjectnullable

Scanning stations in this department.

objectstringenumValues:list

Object type for ScanningStation list

page_infoobject

Pagination metadata for ScanningStation list

dataarray of object

Array of ScanningStation resources in this page

machinesobjectnullable

Machines in this department.

objectstringenumValues:list

Object type for Machine list

page_infoobject

Pagination metadata for Machine list

dataarray of object

Array of Machine resources in this page

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

production_stepsobjectnullable

Connected production steps.

objectstringenumValues:list

Object type for ProductionStep list

page_infoobject

Pagination metadata for ProductionStep list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of ProductionStep resources in this page

idstring

Production step ID.

objectstringenumValues:production_step

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

leveling_factorstring (decimal)

Leveling factor as a decimal string.

allowancesstring (decimal)

Allowances as a decimal string.

labor_rateobjectnullable

Labor rate.

labor_timeobjectnullable

Labor time.

overhead_rateobjectnullable

Overhead rate.

productionobjectnullable

Production output.

consumptionsarray of object

Consumptions.

machinesarray of object

Machines assigned to this step.

scanning_stationobjectnullable

Scanning station.

in_stepsarray of object

Input steps feeding into this step.

out_stepsarray of object

Output steps this step feeds into.

departmentobjectnullable

Department.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

machinesobjectnullable

Machines in this department.

objectstringenumValues:list

Object type for Machine list

page_infoobject

Pagination metadata for Machine list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of Machine resources in this page

idstring

Machine ID.

objectstringenumValues:machine

Resource type identifier.

namestring

Display name.

serial_numberstring

Serial number.

notesstringnullable

Notes.

departmentobjectnullable

Associated department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationsobjectnullable

Scanning stations in this department.

objectstringenumValues:list

Object type for ScanningStation list

page_infoobject

Pagination metadata for ScanningStation list

dataarray of object

Array of ScanningStation resources in this page

machinesobjectnullable

Machines in this department.

objectstringenumValues:list

Object type for Machine list

page_infoobject

Pagination metadata for Machine list

dataarray of object

Array of Machine resources in this page

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

last_used_atstring (date-time)nullable

When the user last used 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