Types

InviteCreate

The body that creates an invite and the investor or internal user it is for.

typerequired
string
Who the invite is for: `investor` or `internal_user`. An advisor invite is not available here.One of: investor, internal_user
emailrequired
string (email)
The invitee's email. At most 53 characters, so the sign-in username with its invite suffix fits 64. An email a user, contact or open invite already holds returns 422 `unique`.
title
string | null
The invitee's title, such as Mr, Ms or Dr. Required for an internal user.
first_namerequired
string
The invitee's first name.
last_namerequired
string
The invitee's last name.
sso_id
string | null
The investor's single sign-on id. Not accepted for an internal user.
onboarding_id
string (uuid)
The published investor journey to follow. Required while one is published (422 `required`); an unpublished id, or any id while none is published, is 422 `exists`. Not accepted for an internal user. Fixed after creation.
send
boolean
`true` sends the invitation straight away. `false` leaves an investor's invite a draft, and is not accepted for an internal user.Default: true

Used by (1)