v28

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

Create or Update User Profile

Keep track of who's talking to your AI by creating user profiles with contact information and custom properties.

Provide an externalUserId to identify the user—your ID from your own system. Don't worry about whether they already exist; we'll create them if they're new or update their profile if they already exist. This makes syncing user data effortless.

You can then reference this user in other API calls using the same externalUserId.

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

post/users

Request body

externalUserIdstring required

Your unique identifier for the user. Use this same ID in other API calls to reference this user.

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. Defaults to false.

propertiesobject

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

Response

User profile created or updated successfully

successboolean required

Whether the API call was successful.