v1Resources/Team/postInvite a team member
Invite a team member
Invites a new team member by email. The invited member is always created with the "member" role and, unless permissions are supplied, the default member permission preset — an API key can never invite someone as owner or admin.
post
team:write/api/v1/team/membersRequest body
firstNamestringrequired
The new team member's first name.
lastNamestringrequired
The new team member's last name.
emailstringrequired
The new team member's email address.
permissionsobjectoptional
Per-module access flags to grant. Optional; when omitted (or empty), the default member permission preset is used.
Response
dataobjectoptional
userIdstringoptional
ID of the newly invited team member.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/team/members
Your API key
Request body*
{}