How Do I Create and Update User Accounts with the User API?
Last updated: November 14, 2026
Once the User API's fields are mapped in Ambition, your user management system creates or updates users by posting a file to the integration's endpoint. Each row or JSON object is one user, matched to an existing user by the Unique user ID you chose.
Required permissions:
The Integrations: Edit permission is required to view the User API credentials and uploads.
Find the Endpoint and Token
Go to Admin --> Data --> Integrations, open the Enabled tab, and click on your User API integration.
Click on Credentials in the side menu. Copy the Authentication Token and Endpoint.
Send the User Data
Endpoint: Post to the Endpoint URL, including the slash at the end.
Authorization header: Authorization: Token followed by a space and your Authentication Token.
Content-Type header: application/json for JSON, or text/csv for CSV.
Body: Your users, using the API field names from your field mappings. Each request can be up to 15 MB.
A 201 response means the data was accepted. A 400 response lists what was wrong, such as Invalid JSON or Invalid CSV.
Review What Ambition Received
Click on Data Explorer in the integration's side menu.
Go to Uploads and search for your file based on its upload time and record count.
Click on View to see the file's contents.