Skip to main content
Invite a user to an organization with a role.

​
Parameters

ParameterDescription
EmailThe email address of the invitee.
Organization IDThe id of the org the user is being invited to.
Related LinksA string containing the link’s URL.
RoleThe role public ID that will be granted to to invitee on acceptance.

​
Example Output

{
	"jsonapi": {
		"version": "1.0"
	},
	"data": {
		"type": "org_invitation",
		"id": "d9dee0aa-e832-46c3-93b4-5aef8e350474",
		"attributes": {
			"email": "omer+1688566943456@example.com",
			"role": "d8ba290b-aa9e-4957-9f0b-9409d7b4f883",
			"is_active": true
		},
		"relationships": {
			"org": {
				"links": {
					"related": "/orgs/bdac969a-d4c0-4b3a-905a-8bf7737f8fa8?version=2022-02-16~experimental"
				},
				"data": {
					"type": "org",
					"id": "bdac969a-d4c0-4b3a-905a-8bf7737f8fa8"
				}
			}
		}
	}
}

​
Workflow Library Example

Create Organization Invitation with Snyk and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop
⌘I