Update user by ID
Updates user information for a specific user within the same app
PATCH
/api/v1/{app_id}/users/{user_id}Authorization
AuthorizationAPI key · headerrequiredBearer token (format: "Bearer {token}")
Path parameters
app_idstringrequireduuid of the app
user_idstringrequireduuid of the user
Request body
requiredapplication/jsonUser update data
additionsobjectallow_email_notificationsbooleanallow_phone_notificationsbooleanallow_postal_notificationsbooleancitystringcommentstringcountrystringcountry_codestringcustomer_group_idsstring[]emailstringemail_verifiedbooleanfirst_namestringis_super_adminbooleanlanguagestringlast_namestringmarketstringphone_numberstringpostal_codestringsocial_security_numberstringstatusstringAllowed:
activeinactivependingstore_groupstringstreetstringthird_party_sign_upbooleanResponses
200
Updated user object
additionsobject | nulladdressAddressResponseShow propertiesHide properties
citystringcountrystringcountry_codestringstreetstringzip_codestringaddress_restrictionsOrganisationAddressRestrictionResponse[]Show propertiesHide properties
Array of
OrganisationAddressRestrictionResponseaddressIDstringformattedAddressstringorganisationIDstringorganisationNamestringorganisationNumberstringapp_idstringattributesAttributeResponse[] | nullShow propertiesHide properties
Array of
AttributeResponsedescriptionstringidstringkeystringnamestringtemplate_keystringtranslationsAttributeTranslationsResponseShow propertiesHide properties
descriptionobjectnameobjectvaluesobjectcommentstringcommunication_preferencesCommunicationPreferencesResponseShow propertiesHide properties
allow_emailbooleanallow_postalbooleanallow_smsbooleancreated_atstringcustomer_groupsCustomerGroupRefResponse[] | nullShow propertiesHide properties
Array of
CustomerGroupRefResponseidstringnamestringslugstringemailstringemail_verifiedbooleanfilesFileResponse[] | nullShow propertiesHide properties
Array of
FileResponseapp_idstringcontent_typestringcreated_atstringcustom_fieldsobjectfilenamestringidstringupdated_atstringurlstringfirst_namestringidstringis_super_adminbooleanlanguagestringlast_login_atstringlast_namestringmarketstringmarket_currencystringmarket_idstring | nullorganisationsOrganisationWithUserRelationResponse[] | nullShow propertiesHide properties
Array of
OrganisationWithUserRelationResponseapp_idstringattributesAttributeResponse[] | nullShow propertiesHide properties
Array of
AttributeResponsedescriptionstringidstringkeystringnamestringtemplate_keystringtranslationsAttributeTranslationsResponsevaluesobjectbilling_addressCompanyAddressResponse[] | nullShow propertiesHide properties
Array of
CompanyAddressResponsecitystringco_addressstringcompany_idstringcompany_namestringcountrystringcreated_atstringhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringshipping_typestringstate_provincestringstreet_addressstringupdated_atstringcommentstringcontact_namestringcreated_atstringcredit_checkbooleancustom_fieldsobjectcustom_role_idstring | nullcustomer_groupsCustomerGroupRefResponse[] | nullShow propertiesHide properties
Array of
CustomerGroupRefResponseidstringnamestringslugstringemailstringexternal_refstringfilesFileResponse[] | nullShow propertiesHide properties
Array of
FileResponseapp_idstringcontent_typestringcreated_atstringcustom_fieldsobjectfilenamestringidstringupdated_atstringurlstringidstringinvoice_emailstringlevelstring | nullnamestringorganisation_numberstring | nullparent_idstring | nullphonestringrolestring | nullrole_namestring | nullshipping_addressCompanyAddressResponse[] | nullShow propertiesHide properties
Array of
CompanyAddressResponsecitystringco_addressstringcompany_idstringcompany_namestringcountrystringcreated_atstringhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringshipping_typestringstate_provincestringstreet_addressstringupdated_atstringstatusstringstore_groupsStoreGroupResponse[] | nullShow propertiesHide properties
Array of
StoreGroupResponsecountry_of_salestring | nullcreated_atstringdescriptionstring | nullidstringnamestringslugstringstore_typestringupdated_atstring | nulltagsTagResponse[] | nullShow propertiesHide properties
Array of
TagResponseapp_idstringidstringkeystringnamestringtax_id_vat_numberstringupdated_atstringphone_numberstringsocial_security_numberstringstatusstringstore_groupstringstore_group_idstring | nulltagsTagResponse[]Show propertiesHide properties
Array of
TagResponseapp_idstringidstringkeystringnamestringthird_party_sign_upbooleanupdated_atstring400
Invalid request
detailsstring[] | nullmessagestringsuccessboolean401
Unauthorized access
detailsstring[] | nullmessagestringsuccessboolean404
User not found
detailsstring[] | nullmessagestringsuccessboolean500
Internal server error
detailsstring[] | nullmessagestringsuccessboolean