Skip to main content
POST
Add a person to 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.

Scopes

clients:write

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60

Body

application/json
name
string
required
Required string length: 1 - 120
role
enum<string>
required

primary (the main person; a client has exactly one), partner, dependant (no email, never invited to the portal) or other.

Available options:
primary,
partner,
dependant,
other
email
string · null · null

An email address.

Maximum string length: 254
phone
string · null · null

A phone number, such as 0412 345 678 or +61 412 345 678.

Maximum string length: 30

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.