Which User Fields Can the User API Update?

Last updated: November 14, 2026

Each option in the Ambition Fields drop-down menu has a tag that shows what kind of data it updates: User, Integration, Group membership, or Group manager. Only the Email, First Name, and Last Name fields are required for the User API integration.

Required permissions:

  • The Integrations: Edit permission is required to change User API field mappings.

User Fields

  • Email, First Name, and Last Name: Required. If email is your unique user ID, sending a new email creates a new user instead of changing the existing user's email.

  • Username: Required if you use the Salesforce integration. Enter the user's Salesforce username.

  • Time Zone: A time zone name such as America/New_York. In a CSV, every row must have a value if the column is included.

  • Manager: The manager's email, or Salesforce username if you use Salesforce. A blank cell, or a manager without an active account, clears the user's manager.

  • Is Active, Is Manager, and Is Admin: True or False. In a CSV, every row needs a value for Is Manager and Is Admin. Is Manager can't change to False while the user still manages a Group.

Integration IDs

Options named like "Cisco Extension (Cisco)" add an ID for that integration, such as a phone extension or employee ID. Map one column or key to each integration ID. Make sure to set up the corresponding integration before mapping this field.

Group Fields

  • Group membership: One option per Group Type. Enter the name of the Group the user belongs to. Groups that don't exist yet will be created, but Group Types won't be.

  • Group manager: One option per Group Type. Separate several Group names with semicolons. A blank cell removes the user as a manager of every Group of that type.

Group names are case-sensitive and can't contain semicolons. A spelling or capitalization difference will create a new Group.


Related Articles