Create and send an organization invitation

Create an invitation to join an existing organization. The organization ID is specified in the URL.

organizationIdstringRequired

Organization ID to invite the user to

This endpoint expects an object.

emailstringRequiredformat: "email"

Email address of the user to invite

roleslist of stringsRequired

Array of role IDs or names to assign to the user for the organization. Must contain at least 1 role.

Organization invitation created and sent successfully.

successboolean or null

messagestring or null

organizationIdstring or null

1	import requests
2
3	url = "https://api.koywe.com/api/v1/users/organizations/organizationId/invitations"
4
5	payload = {
6	"email": "invited.user@example.com",
7	"roles": ["USER_ORG_ADMIN", "PLATFORM_ADMIN"]
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"success": true,
3	"message": "Invitation sent to user@example.com for organization My Organization",
4	"organizationId": "org3_xxxxxxxxxxxxxx"
5	}