createInvite( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates and sends invite emails to a list of potential team members, inviting them to become team members of the requesting account. The invites may be limited to a specific resource (site or other asset). Maximum 50 invitees can be specified per call.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Method Declaration
Copy
Method Parameters
subjectsAssignmentsArray<SubjectInviteAssignments>Required

Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite).


optionsCreateInviteOptions

Filter options.

Returns
Return Type:Promise<CreateInviteResponse>
Did this help?