User Creation + Management
Last updated
Was this helpful?
Last updated
Was this helpful?
User Preferences: The settings shown above are recommended for integrations
Role Assignment: Use DefaultUserRole
unless specific custom roles are required
Custom Roles: Contact the Amigo team if custom role definitions are needed
Timezone: The timezone
field in user preferences (found within the user_preferences
object in the request body for user creation, or directly in the request body for user updates) sets the user's timezone using IANA tz database format (e.g., "America/New_York"). This is crucial as it affects how the Amigo agent perceives time for the user, including interpreting timestamps for events and understanding time-related queries (e.g., "morning" vs. "night"). If not specified, the organization's default timezone is used, or UTC if the organization's default is not set.
Get users subject to filters as follows:
Update a user's details as follows:
Delete a user with a given user ID as follows:
A 200 response means the user was deleted. However, internally the deletion may be either implemented as a hard or soft delete. A soft delete is reflected by a non-emptynot_deletable_reasons
array in the response.
User ID Mapping: Save the returned user_id
and map it to your internal user management system
Auth Token Management: Generate and manage auth tokens for each user as needed
User State Tracking: Maintain user state in your system to provide seamless experiences
Retrieve all users in an organization.
This endpoint is impacted by the following permissions:
User:GetUserInfo
permission for are returned.Whether the user is verified.
The ID of the user.
The email of the user,
The maximum number of users to retrieve.
100
The token from the previous request to return the next page of users.
0
The fields to sort the users by. Supported fields are first_name
, last_name
, email
, user_stats.num_conversations
, and user_stats.num_messages
. Specify a +
before the field name to indicate ascending sorting and -
for descending sorting. Multiple fields can be specified to break ties.
[]
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
Delete an user. This endpoint deletes the user from the Amigo system, and also deletes all the user's information as much as possible.
User
object, which is marked deleted
. The Google user is deleted as well.This endpoint requires the following permissions:
User.DeleteUser
on the user to delete.The identifier of the user to delete.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
If login_link
is not-None
, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login
and start their Amigo experience. Otherwise, no email will be sent.
This endpoint requires the following permissions:
User:InviteUser
on the user to invite.The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
The first name of the user.
The last name of the user.
The email of the user. This email uniquely identifies the user in the organization.
If specified, this link will be sent to the user's email as the link to start their Amigo experience. For Amigo's frontend, this would be the user's organization's login page with their email already filled in.
The role to assign to the user. Only roles that are returned from the Get roles endpoint are allowed.
If specified, the user's preferences will be set to this value instead of the organization default.
Update information about an user. Only fields that are specified in the request are updated.
This endpoint requires the following permissions:
User:UpdateUserInfo
for the user to update.The identifier of the user to update information for.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
The first name of the user to update. If null
, the first name is not modified.
The last name of the user to update. If null
, the last name is not modified.
Whether to automatically recommend responses to the user if the user hasn't replied to the coach for a while. If null
, the preference is not modified.
The preferred language for the user. The agent will attempt to converse to the user in this language if set. This field must be in the ISO 639-1 alpha-2 format.
If null
, erase the user's preferred setting, and the specific language used will be the agent's default spoken language. In order to not update this field, leave it out of the request or
set it to an empty object (_NotSet
).
{}
^\w{2}$
A specific type to indicate that a field is not set in the request.
The user's timezone in the IANA tz database format. If not specified, the organization's timezone is used.
{}
A specific type to indicate that a field is not set in the request.
Whether conversations are visible to the admins. If null
, the preference is not modified.
Whether the user's user model is visible to the admins. If null
, the preference is not modified.
A list of additional context to update. If null
, the context is not modified.
No content