Update Account User
Beta/v1/identity/account-users/{id}Idempotent with Idempotency-Key header. Learn more
Partially updates an account user.
idstringAccount user ID.
nameoptional stringDisplay name.
emailoptional stringEmail address.
usernameoptional stringUsername.
role_idoptional stringnullableRole ID. Send null to clear.
department_idoptional stringnullableDepartment ID. Send null to clear.
preferencesarray of objectNotification preferences to toggle (external targets only).
notification_type_codestringenumValues:invoiceorder_acknowledgementpurchase_order_submissionNotification type code. Must match a value of constants.AccountRelationNotificationType.
enabledbooleanWhether this notification type is enabled for the account user.
idstringAccount user ID.
objectstringenumValues:account_userResource type identifier.
namestringnullableDisplay name.
emailstringnullableEmail address.
usernamestringnullableUsername.
image_urlstringnullableProfile image URL.
statusstringenumValues:activedisabledremovedAccount user status.
roleobjectnullableAssigned role.
idstringRole ID.
objectstringenumValues:roleResource type identifier.
namestringDisplay name.
typestringenumValues:adminuserscannerRole type code.
ownerobjectnullableOwner of this resource.
objectstringenumValues:ownerResource type identifier.
typestringenumValues:systemaccountThe owner type: "system" for platform defaults, "account" for account-owned resources.
accountobjectnullableThe account that owns this resource. null if the object is system-owned.
idstringAccount ID.
objectstringenumValues:accountResource type identifier.
namestringDisplay name.
default_billing_addressobjectnullableDefault billing address.
idstringAddress ID.
objectstringenumValues:addressResource type identifier.
namestringDisplay name of the address.
phonestringnullablePhone number associated with the address.
emailstringnullableEmail address associated with the address.
is_drop_shipbooleanWhether the address is a drop ship location.
geolocationobjectnullableGeolocation details for the address.
idstringGeolocation ID.
objectstringenumValues:geolocationResource type identifier.
street_line_1stringnullableFirst line of the street address.
street_line_2stringnullableSecond line of the street address.
localitystringnullableCity or locality.
statestringnullableState or administrative area.
postal_codestringnullablePostal or ZIP code.
countrystringTwo-letter country code.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
default_shipping_addressobjectnullableDefault shipping address.
idstringAddress ID.
objectstringenumValues:addressResource type identifier.
namestringDisplay name of the address.
phonestringnullablePhone number associated with the address.
emailstringnullableEmail address associated with the address.
is_drop_shipbooleanWhether the address is a drop ship location.
geolocationobjectnullableGeolocation details for the address.
idstringGeolocation ID.
objectstringenumValues:geolocationResource type identifier.
street_line_1stringnullableFirst line of the street address.
street_line_2stringnullableSecond line of the street address.
localitystringnullableCity or locality.
statestringnullableState or administrative area.
postal_codestringnullablePostal or ZIP code.
countrystringTwo-letter country code.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
brandingobjectnullableBranding configuration.
idstringBranding ID.
objectstringenumValues:account_brandingResource type identifier.
support_emailstringnullableSupport email address.
phone_numberstringnullableSupport phone number.
logo_urlstringnullableLogo URL (S3 key).
facebook_handlestringnullableFacebook handle.
instagram_handlestringnullableInstagram handle.
linkedin_handlestringnullableLinkedIn handle.
twitter_handlestringnullableTwitter handle.
website_urlstringnullableWebsite URL.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
portalobjectnullablePortal configuration.
idstringPortal ID.
objectstringenumValues:account_portalResource type identifier.
slugstringPortal 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 stringnullablePermissions in {domain}:{action} format.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
departmentobjectnullableAssigned department.
idstringDepartment ID.
objectstringenumValues:departmentResource type identifier.
namestringDisplay name.
notesstringnullableNotes about the department.
locationobjectnullableAssociated location.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
childrenobjectnullableChild locations. Expandable.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
childrenobjectnullableChild locations. Expandable.
objectstringenumValues:listObject type for Location list
page_infoobjectPagination metadata for Location list
dataarray of objectArray of Location resources in this page
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
childrenobjectnullableChild locations. Expandable.
objectstringenumValues:listObject type for Location list
page_infoobjectPagination metadata for Location list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of Location resources in this page
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
childrenobjectnullableChild 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.
childrenobjectnullableChild locations. Expandable.
objectstringenumValues:listObject type for Location list
page_infoobjectPagination metadata for Location list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of Location resources in this page
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
childrenobjectnullableChild locations. Expandable.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
childrenobjectnullableChild locations. Expandable.
objectstringenumValues:listObject type for Location list
page_infoobjectPagination metadata for Location list
dataarray of objectArray 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_stationsobjectnullableScanning stations in this department.
objectstringenumValues:listObject type for ScanningStation list
page_infoobjectPagination metadata for ScanningStation list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of ScanningStation resources in this page
idstringScanning station ID.
objectstringenumValues:scanning_stationResource type identifier.
namestringDisplay name.
notesstringnullableNotes.
typestringenumValues:init_batchmerge_batchmove_batchScanning station type.
label_sizestringnullableenumValues:1x11x31x4Label size code.
label_typestringnullableenumValues:tagtravelerLabel type code.
material_check_requiredbooleanWhether material check is required.
departmentobjectnullableDepartment.
idstringDepartment ID.
objectstringenumValues:departmentResource type identifier.
namestringDisplay name.
notesstringnullableNotes about the department.
locationobjectnullableAssociated location.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
childrenobjectnullableChild locations. Expandable.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
scanning_stationsobjectnullableScanning stations in this department.
objectstringenumValues:listObject type for ScanningStation list
page_infoobjectPagination metadata for ScanningStation list
dataarray of objectArray of ScanningStation resources in this page
machinesobjectnullableMachines in this department.
objectstringenumValues:listObject type for Machine list
page_infoobjectPagination metadata for Machine list
dataarray of objectArray of Machine resources in this page
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
production_stepsobjectnullableConnected production steps.
objectstringenumValues:listObject type for ProductionStep list
page_infoobjectPagination metadata for ProductionStep list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of ProductionStep resources in this page
idstringProduction step ID.
objectstringenumValues:production_stepResource type identifier.
namestringDisplay name.
notesstringnullableNotes.
leveling_factorstring (decimal)Leveling factor as a decimal string.
allowancesstring (decimal)Allowances as a decimal string.
labor_rateobjectnullableLabor rate.
labor_timeobjectnullableLabor time.
overhead_rateobjectnullableOverhead rate.
productionobjectnullableProduction output.
consumptionsarray of objectConsumptions.
machinesarray of objectMachines assigned to this step.
scanning_stationobjectnullableScanning station.
in_stepsarray of objectInput steps feeding into this step.
out_stepsarray of objectOutput steps this step feeds into.
departmentobjectnullableDepartment.
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.
machinesobjectnullableMachines in this department.
objectstringenumValues:listObject type for Machine list
page_infoobjectPagination metadata for Machine list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of Machine resources in this page
idstringMachine ID.
objectstringenumValues:machineResource type identifier.
namestringDisplay name.
serial_numberstringSerial number.
notesstringnullableNotes.
departmentobjectnullableAssociated department.
idstringDepartment ID.
objectstringenumValues:departmentResource type identifier.
namestringDisplay name.
notesstringnullableNotes about the department.
locationobjectnullableAssociated location.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name.
typestringenumValues:buildingsectionaisleLocation type code.
parentobjectnullableParent location. Null for top-level locations. Expandable.
childrenobjectnullableChild locations. Expandable.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
scanning_stationsobjectnullableScanning stations in this department.
objectstringenumValues:listObject type for ScanningStation list
page_infoobjectPagination metadata for ScanningStation list
dataarray of objectArray of ScanningStation resources in this page
machinesobjectnullableMachines in this department.
objectstringenumValues:listObject type for Machine list
page_infoobjectPagination metadata for Machine list
dataarray of objectArray 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)nullableWhen 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
Successful response for Update Account User