Skip to main content
PATCH
/
v1
/
users
/
update
User Update Operation
curl --request PATCH \
  --url https://api.iklim.co/v1/users/update \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": "88a52d74-ebee-49a4-9631-cfe492f4bf53",
  "username": "newuser@domain.com",
  "password": "newStr0ng!P@ssw0rd",
  "firstName": "<string>",
  "midName": "<string>",
  "lastName": "<string>",
  "locale": "tr_TR",
  "timezone": "Europe/Istanbul",
  "roles": "['\''API_USER'\'']",
  "status": "INACTIVE",
  "empty": true
}'
{
  "userId": "8e94a551-5b86-40ba-ae55-b019dee5cc25",
  "username": "name@domain.com",
  "firstName": "John",
  "midName": "Bob",
  "lastName": "Doe",
  "locale": "tr_TR",
  "timezone": "Europe/Istanbul",
  "roles": "API_USER",
  "status": "INACTIVE",
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "INDIVIDUAL",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "mobilePhoneNumber": "<string>",
    "location": "<string>",
    "company": "<string>",
    "industry": "<string>",
    "profilePictureUrl": "<string>",
    "subscriptionPlan": "NONE",
    "emailVerified": true,
    "mobilePhoneNumberVerified": true
  }
}

Body

application/json
​
userId
string
required

Identifier of the Updating User

Example:

"88a52d74-ebee-49a4-9631-cfe492f4bf53"

​
username
string

New Username. This Field Can Be Updated by the User Themselves or by Users with POWER_USER Role!

Example:

"newuser@domain.com"

​
password
string

User's New Password. This Field Can Only Be Updated by Users with ADMIN Role!

Example:

"newStr0ng!P@ssw0rd"

​
firstName
string

User's New First Name

​
midName
string

User's New Middle Name

​
lastName
string

User's New Last Name

​
locale
string

User's New Locale

Example:

"tr_TR"

​
timezone
string

User's New Time Zone

Example:

"Europe/Istanbul"

​
roles
enum<string>[]

User's New Roles. This Field Can Only Be Updated by Users with ADMIN Role!

Example:

"['API_USER']"

​
status
enum<string>

User's New Status. This Field Can Only Be Updated by Users with ADMIN Role!

Available options:
INACTIVE,
ACTIVE,
EXPIRED,
BLOCKED,
DELETED
Example:

"INACTIVE"

​
empty
boolean

Response

Successful User Update

​
userId
string
required

ID Number of Registered User

Example:

"8e94a551-5b86-40ba-ae55-b019dee5cc25"

​
username
string
required

Registered User Name

Example:

"name@domain.com"

​
firstName
string
required

Registered User First Name

Example:

"John"

​
lastName
string
required

Registered User Last Name

Example:

"Doe"

​
locale
string
required

Registered User Locale

Example:

"tr_TR"

​
timezone
string
required

Registered User Time Zone Id

Example:

"Europe/Istanbul"

​
roles
enum<string>[]
required

Registered User Roles

Example:

"API_USER"

​
status
enum<string>
required

Registered User Status

Available options:
INACTIVE,
ACTIVE,
EXPIRED,
BLOCKED,
DELETED
Example:

"INACTIVE"

​
midName
string

Registered User Mid Name

Example:

"Bob"

​
account
object