Viviot.Api

<back to all web services

UpdateBusinessUser

Requires Authentication
Requires any of the roles:Admin, TenantAdmin
The following routes are available for this service:
PUT/userUpdates a business user.
UpdateBusinessUser Parameters:
NameParameterData TypeRequiredDescription
UserIdbodyintYesID of the user whose data is to be updated.
BaseEditBusinessUser Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYesThe user's first name.
LastNameformstringYesThe user's last name.
EmailformstringYesThe user's email address.
PhoneNumberformstringNoThe user's phone number.
RolesformarrayYesThe user's roles.
ViviotIdformstringNoOptional association to a Viviot user.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
BusinessUserProfileDataResponse Parameters:
NameParameterData TypeRequiredDescription
DataformBusinessUserProfileDataViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BusinessUserProfileDataView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ActivationStatusformActivationStatusNo
UserNameformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
TemporaryEmailformstringNo
EmailConfirmedformboolNo
PhoneNumberformstringNo
TemporaryPhoneNumberformstringNo
PhoneNumberConfirmedformboolNo
RolesformList<string>No
OrganizationIdformGuid?No
BusinessOrganizationsformHashSet<OrganizationBasicView>No
ViviotIdformstringNo
ImageContentformstringNo
ImageUrlformstringNo
ActivationStatus Enum:
NameValue
Unconfirmed0
Temporary10
OwnershipConfirmed20
IdentityConfirmed30
OrganizationBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
TypeformOrganizationTypeNo
SubOrganizationsformList<OrganizationBasicView>No
OrganizationType Enum:
NameValue
Unknown0
Admin10
Tenant20
Location30

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /user HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"userId":0,"firstName":"String","lastName":"String","email":"String","phoneNumber":"String","roles":["String"],"viviotId":"String","version":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":{"id":0,"activationStatus":0,"userName":"String","firstName":"String","lastName":"String","email":"String","temporaryEmail":"String","emailConfirmed":false,"phoneNumber":"String","temporaryPhoneNumber":"String","phoneNumberConfirmed":false,"roles":["String"],"organizationId":"00000000000000000000000000000000","businessOrganizations":[{"id":"00000000000000000000000000000000","name":"String","type":0,"organizations":[{"id":"00000000000000000000000000000000","name":"String","type":0,"organizations":[{"id":"00000000000000000000000000000000","name":"String","type":0,"organizations":[{}]}]}]}],"viviotId":"String","imageContent":"String","imageUrl":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}