Create and send an organization invitation

Create an invitation to join an organization. Supports two scenarios:

Invite to existing organization: Provide ‘existingOrganizationId’ to invite user to an existing organization
Create new organization: Provide ‘newOrganizationName’ (and optionally ‘newOrganizationDescription’) to create a new organization and invite the user to it

The DTO validates that exactly one of these approaches is used.

This endpoint expects an object.

objectRequired

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/organization-invitations"
4
5	payload = {
6	"email": "invited.user@example.com",
7	"roles": ["USER_ORG_ADMIN", "PLATFORM_ADMIN"],
8	"existingOrganizationId": "org_123456789"
9	}
10	headers = {
11	"Authorization": "Bearer <token>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

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