Skip to main content
POST
Invite Team
Invites a team to the specified location by email. The invited user will receive an email with a link to accept the invitation. The authenticated user must have a verified email address. Rate limited to 5 requests per minute.
site
string
required
The UUID of the location.
email
string
required
The email address of the user to invite. Maximum 255 characters.
transfer_ownership
boolean
Whether to transfer location ownership to the invited team upon acceptance.
data_access
boolean
Whether to grant sensitive data access to the invited team.
data_access_expires_at
string
ISO 8601 date for when the data access expires. Must be a future date.
can_access_all_assets
boolean
Whether the invited team can access all assets on the location.
accessible_assets
array
An array of specific assets the team can access. Required when can_access_all_assets is false.

Response

message
string
A confirmation message indicating the invite was created successfully.
invite
object
The created invitation object.
invite_token
string
The invitation token used for acceptance.
Links for accepting the invitation.