Update User Profile

Enum: "Pacific Time - 01:00 am - UTC-7" "Arizona Time - 01:00 am - UTC-7" "Mountain Time - 02:00 am - UTC-6" "Central Time - 03:00 am - UTC-5" "Eastern Time - 04:00 am - UTC-4" "Hawaii Time - 10:00 pm - UTC-10" "Alaska Time - 00:00 am - UTC-8"

isMfaActive

boolean (IsMfaActive)

Is Multi-Factor Authentication enabled.

isUserActive

boolean (IsUserActive)

Is the User account active.

isUserLocked

boolean (IsUserLocked)

Is the user account locked.

Array of objects (EmailAddressesArray)

Array

email required	string <email> Email address.
label required	string Label indicating type of email address (e.g., work, personal)
primary required	boolean True or false value indicating if email address is the primary email address for the account. Primary email addresses are used for user communication and are one option for user Login credentials (with phone number)

Array of objects (PhoneNumbersArray)

Array

phoneNumber required	string Phone number.
label required	string Label indicating type of phone number (e.g., work, personal)
primary required	boolean True of false value indicating if phone number is the primary phone number for the account. Primary phone numbers are used for user communication and are one option for user Login credentials (with email address).

Array of objects (ClientRole)

Array

clientId	string <UUID> Unique identifier for the client.
clientName	string The name of the client (DBA).
userRoles	string The roles assigned to the user for a specific client account. Enum: "Admin" "Merchant" "Agent" "Support" "View"

object (CustomPropertiesInput)

An object containing user-defined key/value pairs.

property name*

additional property

string

echo

string

Responses

200

User updated successfully.

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource was not found

409

Conflict.

429

Too Many Requests

put/users/{userId}

Request samples

{"firstName": "string",
"lastName": "string",
"timezone": "Pacific Time - 01:00 am - UTC-7",
"isMfaActive": true,
"isUserActive": true,
"isUserLocked": false,
"emailAddresses": [[{"email": "bob.smith@acme.com",
"label": "work",
"primary": true
},
{"email": "buck.wild@gmail.com",
"label": "personal",
"primary": false
}
]
],
"phoneNumbers": [[{"phoneNumber": "5555556666",
"label": "mobile",
"primary": true
},
{"phoneNumber": "5555553322",
"label": "office",
"primary": false
}
]
],
"clientRoles": [{"clientId": "2ad8662d-595c-44d0-a726-d341684e8cda",
"clientName": "Acme Co.",
"userRoles": "Admin"
}
],
"userDefinedFields": {"custom_field1": "Custom value 1",
"custom_field2": "Custom value 2"
},
"echo": "string"
}

Response samples

{"userId": "8fffb4e6-6661-41fe-9511-20aad576c574",
"firstName": "Leonard",
"lastName": "Smith",
"timezone": "Pacific Time - 01:00 am - UTC-7",
"isMfaActive": true,
"isUserActive": true,
"isUserLocked": false,
"emailAddresses": [{"email": "bob.smith@acme.com",
"label": "work",
"primary": true
},
{"email": "buck.wild@gmail.com",
"label": "personal",
"primary": false
}
],
"phoneNumbers": [{"phoneNumber": "5555556666",
"label": "mobile",
"primary": true
},
{"phoneNumber": "5555553322",
"label": "office",
"primary": false
}
],
"userRolesByClient": [{"clientId": "987654",
"name": "Acme Co",
"userRoles": ["admin"
],
"cryptoKeys": {"deviceEncryptionKey": "63ee6fab-2e6d-4f7b-8e4b-c6643e4cf364",
"transactionEncryptionKey": "b465a1e9-42a1-4c22-a33d-f1faa80ea3b7"
}
},
{"clientId": "324234",
"name": "Pace Software",
"userRoles": ["agent",
"merchant"
],
"cryptoKeys": {"deviceEncryptionKey": "6777c9a9-2524-405b-b71f-ccbfd7cc2645",
"transactionEncryptionKey": "243df8d8-b468-4fab-b79c-e6aa8932dc63"
}
}
],
"sessionDetails": {"id": "string",
"logonTime": "2019-08-24T14:15:22Z",
"expireTime": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"browserAgent": "string"
}
}

Update User Profile

path Parameters

header Parameters

Request Body schema: application/UNENCRYPTED—DO_NOT_SEND+jsonapplication/jsonapplication/UNENCRYPTED—DO_NOT_SEND+json

Request Body schema:
application/UNENCRYPTED—DO_NOT_SEND+json