Invite User
Sends an email invitation to join your workspace to the provided email. If the user doesn’t have an account they will be prompted to create one. If the user accepts this invite they will be added as a user to your workspace and your subscription using one of your seats. This endpoint may only be called by workspace members with the WORKSPACE_MEMBERS_INVITE permission. If the user is already in the workspace a 400 error will be returned.
Headers
Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.
Body
The email address to invite.
"john.doe@testmail.com"
The product seat assigned when the invitation is accepted.
workspace_admin, workspace_member, workspace_lite_member Workspace groups to apply after the invitation is accepted.
Optional per-member usage limit to apply after the invitation is accepted.
x >= 0Response
Successful Response
The status of the workspace invite request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.