PATCH
/
v1
/
users
/
{user_id}
curl --request PATCH \
  --url https://api.ziplink.click/v1/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[email protected]",
  "first_name": "Test",
  "last_name": "User"
}'
{
  "confirmed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "email": "[email protected]",
  "first_name": "Test",
  "id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "last_name": "User",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
user_id
string
required

ID of the user.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Body

application/json
Update the user.
​
email
string

Email address of the user.

Required string length: 6 - 254
Example:

"[email protected]"

​
first_name
string | null

First name of the user.

Required string length: 1 - 50
Example:

"Test"

​
last_name
string | null

Last name of the user.

Required string length: 1 - 50
Example:

"User"

​
new_password
string

New password of the user.

Required string length: 8 - 64
Example:

"super-secret"

​
password
string

Password of the user. Required together with the new_password field.

Required string length: 8 - 64
Example:

"super-secret"

​
status
enum<string>

Status of the user.

Available options:
active,
pending,
inactive,
deleted
Example:

"active"

Response

200
application/json
OK

A user in the system.

​
confirmed_at
string | null
required

Date when the user was confirmed.

​
created_at
string
required

Date when the user was created.

​
email
string
required

Email address of the user.

Required string length: 6 - 254
Example:

"[email protected]"

​
first_name
string
required

First name of the user.

Required string length: 1 - 50
Example:

"Test"

​
id
string
required

Unique identifier of the user.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
last_name
string
required

Last name of the user.

Required string length: 1 - 50
Example:

"User"

​
status
enum<string>
required

Status of the user.

Available options:
active,
pending,
inactive,
deleted
Example:

"active"

​
updated_at
string | null
required

Date when the user was updated.