Skip to main content
POST
Create Company User

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

email
string
required

Email address of the user

username
string

Username for the user

external_id
string

External identifier for the user

active
boolean

Whether the user account is active

Body

application/json
affiliate
object | null
username
active
boolean | null
email
first_name
last_name
password

Password for the user. This will be assigned if the User does not exist yet or if they do not have a password set.

avatar
phone
google_id
bio
facebook
instagram
twitter
linkedin
whatsapp
wechat
youtube
zip_code
dob
gender
time_zone
push_notifications
email_notifications
sms_notifications
language_code
country_code

Response

Created

A company member (rep or admin) with the user profile it belongs to. On a sandbox test store, a droplet or OAuth token receives no username, image_url, mysite_url, legacy_number, roles, share_guid, affiliate or user.

id

Member ID. Use it as {id} on the other company user endpoints.

company_id
integer | null

ID of the company the membership belongs to.

active
boolean | null

Whether the membership is active.

external_id
string | null

The member's ID in your external system.

username
string | null

Member username, used in share links.

image_url
string | null

Avatar URL.

mysite_url
string | null

URL of the member's personal site.

legacy_number

Legacy member number carried over from a previous system, if any.

metadata
object | null

Custom key-value data stored on the member.

roles
string | null

Member type slug (for example rep or customer), or admin.

share_guid
string | null

Share identifier (mirrors username).

affiliate
object | null

The member's sponsor. An empty object when the member has no sponsor.

rank
string | null

External ID of the member's rank.

member_id
string | null

Member UUID, the same key sent in member webhooks. Null for older records that have none yet.

user
object | null

The user profile behind the membership.