PUT
/
security
/
merchantUsers
/
update
cURL
curl -X PUT "https://api.onekhusa.com/sandbox/v1/security/merchantUsers/update" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "X-Organisation-Id: FYH0NTVW0DXK" \
  --header "X-Merchant-Account-Number: 35253486" \
  --header "Accept-Language: en" \
  -d '{
    "userId": "user-id-123",
    "merchantAccountNumber": 35253486,
    "firstName": "John",
    "lastName": "Phiri",
    "emailAddress": "john.phiri@example.com",
    "phoneNumber": "0881234567",
    "roleId": "MERC_ADMIN",
    "capturedBy": "admin@example.com"
  }'
"User account has been updated successfully"

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <Token>, where <Token> is your access token.

Headers

ā€‹
X-Organisation-Id
string
required

The organization identifier

ā€‹
X-Merchant-Account-Number
string
required

The merchant account number

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json
ā€‹
userId
string
required

The unique identifier of the user to update

Example:

"user-id-123"

ā€‹
merchantAccountNumber
integer
required

The unique identifier of the merchant account

Example:

35253486

ā€‹
firstName
string
required

The updated first name of the user

Example:

"John"

ā€‹
lastName
string
required

The updated last name of the user

Example:

"Phiri"

ā€‹
emailAddress
string<email>
required

The updated email address of the user (only updated if email is not confirmed)

Example:

"john.phiri@example.com"

ā€‹
phoneNumber
string
required

The updated phone number of the user

Example:

"0881234567"

ā€‹
roleId
string
required

The unique identifier of the role to assign

Example:

"MERC_ADMIN"

ā€‹
capturedBy
string
required

The email address of the user performing the update

Example:

"admin@example.com"

Response

200 - application/json

Success - Merchant user updated successfully

Success message confirming the update

Example:

"User account has been updated successfully"