Skip to main content
first_name
string
required

The user's first name

Example:

"Jane"

last_name
string
required

The user's last name

Example:

"Doe"

email
string
required

The user's email address

Example:

"janedoe@company.com"

sso_id
string

The account's ID global across all ActiveProspect products

Example:

"6493820b542ea0521e2a4543"

api_key
string

The user's API key

Example:

"2f1d5f29915b866c7a2fa5de29613104"

superuser
boolean

Is the user a super user?

Example:

false

user_admin
boolean

Can the user manage other users and verified domains?

Example:

true

subscription_admin
boolean

Can the user manage subscriptions to TrustedForm, LeadConduit, and SuppressionList?

Example:

true

role_string
enum<string>

The user's role (unused)

Available options:
user
Example:

"user"

phone
string

The user's phone number

Example:

"512-555-1212"

accounts
object[]
products
object[]

The list of products available to the account

Example:
[
{
"id": "lcx",
"name": "LeadConduit",
"base_url": "https://app.leadconduit.com",
"marketing_url": "https://activeprospect.com/products/leadconduit/",
"subscribed": true
},
{
"id": "suppressionlist",
"name": "SuppressionList",
"base_url": "https://app.suppressionlist.com",
"marketing_url": "https://activeprospect.com/products/leadconduit/",
"subscribed": true
},
{
"id": "trustedform",
"name": "TrustedForm",
"base_url": "https://app.trustedform.com",
"marketing_url": "https://activeprospect.com/products/trustedform/",
"subscribed": true
}
]
membership
object
permissions
object
product_code
enum<string>

The code for the current product

Available options:
lcx,
trustedform,
suppressionlist,
account
Example:

"lcx"

company_name
string
expires
string<date-time>
subscriptions
object[]
zendesk_jwt
string
created_at
string<date-time>