Sign in
teams

Invite guests to the team by email

Invite guests to existing team channels usign the user's email.

The number of emails that can be sent is rate limited to 20 per hour with a burst of 20 emails. If the rate limit exceeds, the error message contains details on when to retry and when the timer will be reset.

Permissions

Must have invite_guest permission for the team.

post/api/v4/teams/{team_id}/invite-guests/email

Path parameters

team_idstring required

Team GUID

Request body

emailsstring[] required

List of emails

channelsstring[] required

List of channel ids

messagestring

Message to include in the invite

Response

Guests invite successful

statusstring

Will contain "ok" if the request was successful and there was nothing else to return

Changes

No recorded changes to this endpoint across all 1 revision of this API.