Console APIs - Teams
Invite Team Member
Invite a new member to join a team
POST
Invite Team Member
Send an invitation to a user to join a specific team in your organization.Authentication
Requires Console API authentication with bearer token andx-source: console header.
Path Parameters
string
required
Unique identifier of the team to invite the member to.
Request Body
string
required
First name of the person being invited.
string
required
Last name of the person being invited.
string
required
Email address of the person being invited. Must be a valid email format.
string
required
Role to assign to the invited member. Must be one of: “Organization_Admin”, “Organization_User”, “Team_Lead”, “Team_Member”.
Response Fields
object
required
Invitation data object.
Error Responses
400 Bad Request
400 Bad Request
409 Conflict
409 Conflict
Usage Examples
Available Roles
Organization_Admin
Organization_Admin
Full administrative access to the organization and all teams.
Organization_User
Organization_User
Standard user access with team-specific permissions.
Team_Lead
Team_Lead
Lead role with team management capabilities.
Team_Member
Team_Member
Basic team member with limited permissions.
Best Practices
Validate Email
Validate email format before sending invitations.
Check Existing Members
Verify the user isn’t already a team member.
Set Appropriate Role
Assign roles based on the member’s responsibilities.
Track Invitations
Monitor invitation status and send reminders if needed.