Headers
API authentication token in the format: Token {{API_KEY}}
Obtain your API key from the Userpilot Environment Settings.
Body
application/json
The unique identifier for the user. This is the ID that Userpilot uses to identify the user.
Example:
"123987"
Optional user metadata. You can add, remove, or modify any properties as needed for your use case. Note: Only string values are supported (numbers and dates should be sent as strings).
Company information. If provided, company_id
is required. Additional company properties are optional metadata.
Response
401 - application/json
Unauthorized - Invalid API key