v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB
Users

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}

Path parameters

userIdstring required

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

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

Request body

organizationIdstring uuid

The Greenflash organization ID that the user belongs to.

externalOrganizationIdstring

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

namestring

The user's full name.

emailstring email

The user's email address.

phonestring

The user's phone number.

anonymizedboolean

Whether to anonymize the user's personal information.

propertiesobject

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

Response

User profile updated successfully

successboolean required

Whether the API call was successful.