| Requires any of the roles: | Admin, TenantAdmin |
| PUT | /user | Updates a business user. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | body | int | Yes | ID of the user whose data is to be updated. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | Yes | The user's first name. |
| LastName | form | string | Yes | The user's last name. |
| form | string | Yes | The user's email address. | |
| PhoneNumber | form | string | No | The user's phone number. |
| Roles | form | array | Yes | The user's roles. |
| ViviotId | form | string | No | Optional association to a Viviot user. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | BusinessUserProfileDataView | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ActivationStatus | form | ActivationStatus | No | |
| UserName | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| TemporaryEmail | form | string | No | |
| EmailConfirmed | form | bool | No | |
| PhoneNumber | form | string | No | |
| TemporaryPhoneNumber | form | string | No | |
| PhoneNumberConfirmed | form | bool | No | |
| Roles | form | List<string> | No | |
| OrganizationId | form | Guid? | No | |
| BusinessOrganizations | form | HashSet<OrganizationBasicView> | No | |
| ViviotId | form | string | No | |
| ImageContent | form | string | No | |
| ImageUrl | form | string | No |
| Name | Value |
|---|---|
| Unconfirmed | 0 |
| Temporary | 10 |
| OwnershipConfirmed | 20 |
| IdentityConfirmed | 30 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| Type | form | OrganizationType | No | |
| SubOrganizations | form | List<OrganizationBasicView> | No |
| Name | Value |
|---|---|
| Unknown | 0 |
| Admin | 10 |
| Tenant | 20 |
| Location | 30 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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
{Unable to show example output for type 'UpdateBusinessUser' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'BusinessUserProfileDataResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)