USER

Invite User

User can be invited by the super admin in the root domain, or by the other tenant user in the tenant domain.

post/users/invite

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/users/invite
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

x-tenantstring

Request body

companystring required
emailstring email required
role'Owner' | 'Admin' | 'User' | 'Owner (Read Only)' required

Response

Successful Response

idinteger required
uuidstring uuid required
first_namestring nullable
last_namestring nullable
emailstring required
phonestring nullable
is_activeboolean required
is_verifiedboolean required
is_invitedboolean required
is_onboardedboolean required
created_atstring date-time required
role_titlestring nullable

Changes

No recorded changes to this operation across all 82 revisions of this API.