Skip to main content
POST
Add a client

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Body

application/json
name
string
required
Required string length: 1 - 120
email
string
required

An email address.

Maximum string length: 254
kind
enum<string> | null
Available options:
individual,
couple,
company,
trust,
smsf
second_person
object | null
checklist_template_id
string | null

A checklist template id.

Required string length: 1 - 60
send_invite
boolean | null

Default false.

Response

Created.

object
enum<string>
required
Available options:
client
id
string
required
name
string
required
kind
enum<string>
required
Available options:
individual,
couple,
company,
trust,
smsf
status
enum<string>
required
Available options:
not_invited,
invited,
active,
archived
advisor_name
string | null
required
people
object[]
required
created_at
string
required

An ISO 8601 time in UTC.

invited_at
string | null
required

An ISO 8601 time in UTC.

joined_at
string | null
required

An ISO 8601 time in UTC.

archived_at
string | null
required

An ISO 8601 time in UTC.

last_activity_at
string
required

An ISO 8601 time in UTC.