Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.

External Documentation

To learn more, visit the GitHub documentation.

​
Parameters

ParameterDescription
EmailEmail address of the person you are inviting, which can be an existing GitHub user.
OrgThe name of the organization.
RoleSpecify role for the new member.
Team IDsSpecify IDs for the teams you want to invite new members to.

​
Example Output

{
	"value": {
		"created_at": "2016-11-30T06:46:10-08:00",
		"email": "octocat@github.com",
		"id": 1,
		"invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
		"inviter": {
			"avatar_url": "https://github.com/images/error/other_user_happy.gif",
			"events_url": "https://api.github.com/users/other_user/events{/privacy}",
			"followers_url": "https://api.github.com/users/other_user/followers",
			"following_url": "https://api.github.com/users/other_user/following{/other_user}",
			"gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
			"gravatar_id": "",
			"html_url": "https://github.com/other_user",
			"id": 1,
			"login": "other_user",
			"node_id": "MDQ6VXNlcjE=",
			"organizations_url": "https://api.github.com/users/other_user/orgs",
			"received_events_url": "https://api.github.com/users/other_user/received_events",
			"repos_url": "https://api.github.com/users/other_user/repos",
			"site_admin": false,
			"starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
			"subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
			"type": "User",
			"url": "https://api.github.com/users/other_user"
		},
		"login": "monalisa",
		"node_id": "MDQ6VXNlcjE=",
		"role": "direct_member",
		"team_count": 2
	}
}

​
Workflow Library Example

Onboarding Team Member to Project

Workflow Library

Preview this Workflow on desktop

Was this page helpful?

GitHub Custom ActionList All Organizations