Skip to main content

Version: 20.11 (EOL)

POST Update Current User Profile

Updates the active profile for the user currently logged into the portal. If the user does not have an active profile, one will be created.

This method will also create user scope PropertyTypes if required.

Request

HTTP request

POST https://<JM_SERVER>/workspaces/secure/api/v1/current-user/profile-update

Request body

The POST request must contain a JSON structure describing the current user profile update details. To support multiple parameters this API uses HTTP Content Type: application/json.

The set of query JSON attributes is listed below. All attributes are optional except where otherwise indicated.

AttributeDescription
paramsMap
Required. Specify parameters to pass into the update. Must contain at least one property type map to add to the user profile.

Response

If successful, this operation returns a response with a HTTP 200 OK status code.

Error messages

Error keyErrorHTTP status code
currentUserNotFoundUnable to resolve user from request400 Bad Request
internalErrorPlease see Error Log ID {number}500 Internal Server Error
paramsNotSetParameters not specified400 Bad Request
unableToResolvePortalUnable to resolve portal from request400 Bad Request

Error responses

HTTP status codeDescription
400 Bad RequestBad request or request parameter. Check error message for details.
404 Not FoundEnsure the URL endpoint is entered correctly.
500 Internal Server ErrorException occurred in current user profile update. Contact administrator.

Example

Ensure you specify Content-Type: application/json.

Example request
POST /workspaces/secure/api/v1/current-user/profile-update HTTP/1.1
Host: https://transact.workspaces.com
Content-Type: application/json

{
"params": {
"Email": "[email protected]",
"First Name": "John1",
"Last Name": "Smith",
"Mobile": "0312 392 912"
}
}