Update User Profile

Update specific fields of an existing user profile without changing everything.

The userId in the URL path should be your externalUserId. Only the fields you include in your request will be updated—everything else stays the same. Perfect for targeted updates like changing an email address or adding new properties.

Prefer a simpler approach? Use POST /users instead—it automatically creates or updates the user, so you don’t need to know if they exist yet.

Optionally associate the user with an organization by providing an externalOrganizationId. If the organization doesn’t exist yet, we’ll create it automatically.

PUT /users/{userId}

cURL

cURL

curl --request PUT \
  --url https://www.greenflash.ai/api/v1/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Alice Updated",
  "email": "[e-mail]",
  "properties": {
    "plan": "enterprise"
  }
}
'

200

{
  "success": true,
  "participant": {
    "id": "part-001",
    "externalId": "user-123",
    "organizationId": "org-001",
    "externalOrganizationId": "org-456",
    "name": "Alice Updated",
    "email": "[e-mail]",
    "phone": "[phone]",
    "anonymized": false,
    "properties": {
      "plan": "enterprise"
    },
    "createdAt": "2025-07-01T12:00:00Z",
    "updatedAt": "2025-07-09T08:30:00Z"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

userId · string · required

Your external user ID (the externalUserId used when creating the user)

Body

application/json

Request payload for updating an existing user profile.

organizationId · string<uuid>

The Greenflash organization ID that the user belongs to.

externalOrganizationId · string

Your unique identifier for the organization this user belongs to. If provided, the user will be associated with this organization.

name · string

The user's full name.

email · string<email>

The user's email address.

phone · string

The user's phone number.

anonymized · boolean

Whether to anonymize the user's personal information.

properties · object

Additional data about the user (e.g., plan type, preferences).

Show child attributes

Response

200

application/json

User profile updated successfully

Success response for user update.

success · boolean · required

Whether the API call was successful.

participant · object · required

The user profile.

Show child attributes