Skip to main content
PATCH
/
api
/
v1
/
users
/
{project_user_id}
Update an existing user
curl --request PATCH \
  --url https://api.clix.so/api/v1/users/{project_user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Clix-API-Key: <api-key>' \
  --header 'X-Clix-Project-ID: <api-key>' \
  --data '
{
  "properties": {}
}
'
{
  "properties": {}
}

​
Overview

Updates an existing user identified by their project_user_id. This endpoint allows you to modify user properties. Only the fields provided in the request will be updated.

​
Authentication

This endpoint requires authentication via the following HTTP headers:
  • X-Clix-Project-ID: Your project ID
  • X-Clix-API-Key: Your Clix Secret API Key

​
Path Parameters

ParameterTypeRequiredDescription
project_user_idstringYesThe unique identifier of the user to update

​
Request Body

FieldTypeRequiredDescription
propertiesobjectNoUser properties to update as key-value pairs where values can be string, number, boolean, or null

​
Example Request

PATCH /api/v1/users/clix_user

{
  "properties": {
    "email": "[email protected]",
    "subscription_tier": "premium",
    "last_login": "2025-01-10T12:00:00Z",
    "login_count": 42
  }
}

​
Response

​
Success Response (200 OK)

Returns the updated user properties: 
{
  "properties": {
    "email": "[email protected]",
    "subscription_tier": "premium",
    "last_login": "2025-01-10T12:00:00Z",
    "login_count": 42
  }
}

​
Error Responses

​
400 Bad Request

Returned when:
  • project_user_id is missing or invalid
  • Request body is malformed
Returns a plain text error message: 
Project User Id must be provided

​
404 Not Found

The user with the specified project_user_id does not exist. Returns an empty response body with 404 status code.

​
401 Unauthorized

Authentication failed or invalid API key.

​
Notes

  • Only the properties provided in the request body will be updated
  • Existing properties not included in the request will remain unchanged
  • If the user does not exist, a 404 error will be returned
  • Properties with the same key will be overwritten with the new values
  • The response returns only the properties object, not the full user object

Authorizations

​
X-Clix-Project-ID
string
header
required

Project ID for authentication

​
X-Clix-API-Key
string
header
required

API Key for authentication

Path Parameters

​
project_user_id
string
required

The unique identifier of the user to update

Body

application/json

User data to update

Request to update a user

​
properties
object

User properties to update as key-value pairs

Response

User updated successfully

Response containing the updated user properties

​
properties
object

User properties as key-value pairs