POST
/
v1
/
members

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Body

application/json
​
email
string
required

Email Address

​
first_name
string
required

First Name

Required string length: 2 - 50
​
job_title
string
required

Job Title

Maximum length: 50
​
last_name
string
required

Last Name

Required string length: 2 - 50
​
role
enum<string>
required

Role of the member in the team.

  • admin - ADMINISTRATOR
  • manager - MANAGER
  • staff - STAFF
Available options:
admin,
manager,
staff

Response

201 - application/json
​
id
string
required
​
job_title
string
required
​
role
string
required
​
status
enum<string>
required
  • invited - Invited
  • enabled - Enabled
  • disabled - Disabled
Available options:
invited,
enabled,
disabled
​
user
object
required
​
volume
string
​
volume_currency
string