Create and send an organization invitation

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

organizationIdstringRequired

Organization ID to invite the user to

Request

This endpoint expects an object.

emailstringRequired

Email address or API username (api_<uuid> format) of the user to invite

roleslist of stringsRequired

Array of role IDs to assign to the user for the organization. Must contain at least 1 role. Available organization roles: k3r_user_org_inviter, k3r_user_org_viewer, k3r_user_org_manager, k3r_user_org_operator, k3r_user_org_merchant_admin

Response

Organization invitation created and sent successfully.

successboolean

Indicates whether the operation was successful

messagestring

Message describing the invitation result. For immediate assignments: “Roles assigned immediately…”. For traditional flow: “Invitation sent to…”

organizationIdstring

ID of the organization for this invitation

userExistsboolean

Indicates whether the invited user already exists in the system

rolesAssignedImmediatelyboolean or null

Indicates whether roles were assigned immediately without requiring invitation redemption

1	import requests
2
3	url = "https://api-test.koywe.com/api/v1/users/organizations/organizationId/invitations"
4
5	payload = {
6	"email": "invited.user@example.com",
7	"roles": ["k3r_user_org_inviter", "k3r_user_org_viewer", "k3r_user_org_manager"]
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	"userExists": true,
6	"rolesAssignedImmediately": true
7	}

Create and send an organization invitation

Authentication

Path Parameters

Headers

Request

Response

Errors