Skip to content

Create Users

Endpoint

http
POST /unified/user-directory/users
Integrations supported
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Request Body

Refer Writing data using Unified APIs

name
string
The name of the user
Required in
  • ActiveCampaign
emails
object[]
The emails of the user
Required in
  • ActiveCampaign
  • Salesforce
Supported in
  • Google Workspace
  • Okta
email
string
The email address
type
string
The type of email address
is_primary
boolean
Whether the email address is primary
password
string
Required in
  • ActiveCampaign
  • Google Workspace
username
string
The username of the user
Required in
  • ActiveCampaign
Supported in
  • Okta
  • Salesforce
group
integer
Required in
  • ActiveCampaign
first_name
string
The first name of the user
Required in
  • Google Workspace
  • Salesforce
Supported in
  • Okta
last_name
string
The last name of the user
Required in
  • Google Workspace
  • Salesforce
Supported in
  • Okta
phones
object[]
The phones of the user
Supported in
  • Okta
  • Salesforce
number
string
The phone number
type
string
The type of phone number
roles
object[]
The roles of the user
Required in
  • Salesforce
id
string
The unique identifier for a role
name
string
The name of the role
group
string
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
organization
string
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
timezone
string
The timezone of the user
Required in
  • Salesforce
languages
string[]
The languages preferred by the user
Supported in
  • Salesforce
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · The unique identifier for a user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
first_name
string
The first name of the user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
last_name
string
The last name of the user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
name
string
The name of the user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
username
string
The username of the user
Supported in
  • ActiveCampaign
  • Okta
  • Salesforce
emails
object[]
The emails of the user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
email
string
The email address
type
string
The type of email address
is_primary
boolean
Whether the email address is primary
phones
object[]
The phones of the user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
number
string
The phone number
type
string
The type of phone number
status
string
The status of the user. If no clear mapping is available, then the raw value is returned.
All possible enum values:
  • active
  • inactive
  • deleted
  • invited
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
is_email_verified
boolean
Whether the user's email has been verified
is_2fa_enabled
boolean
Whether the user has 2FA enabled
Supported in
  • ActiveCampaign
  • Google Workspace
roles
object[]
The roles of the user
Supported in
  • Salesforce
id
string
The unique identifier for a role
name
string
The name of the role
group
string
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
organization
string
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
organizations
object[]
The organizations of the user
id
string
The unique identifier for an organization
name
string
The name of the organization
licenses
object[]
The licenses of the user or the products the user has access to
id
string
The unique identifier for a license
name
string
The name of the license
organization
string
The unique identifier of the organization to which the license belongs
last_active_at
string
The date and time the user was last active for the license
groups
object[]
The groups of the user
id
string
The unique identifier for a group
name
string
The name of the group
organization
string
The unique identifier of the organization to which the group belongs
avatar
string
The avatar of the user
Supported in
  • Google Workspace
  • Salesforce
timezone
string
The timezone of the user
Supported in
  • ActiveCampaign
  • Okta
  • Salesforce
languages
string[]
The languages preferred by the user
Supported in
  • ActiveCampaign
  • Google Workspace
  • Okta
  • Salesforce
bio
string
The bio of the user
Supported in
  • Salesforce
created_at
string
The date and time the user was created
Supported in
  • Google Workspace
  • Okta
  • Salesforce
updated_at
string
The date and time the user was last updated
Supported in
  • Okta
  • Salesforce
last_active_at
string
The date and time the user was last active
last_login_at
string
The date and time the user was last logged in
Supported in
  • Google Workspace
  • Okta
  • Salesforce
status_changed_at
string
The date and time the user's status was last changed
Supported in
  • Okta
activated_at
string
The date and time the user was activated
Supported in
  • Okta
remote_data
object
Raw data returned from the remote API call.