Send an invitation to join an organization

POST

/api/v1/organizations/{orgId}/invites

Sends an email invitation to a user to join the specified organization with a given role. Requires JWT authentication and the user must be an Admin or Owner of the organization.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://useraccounts.srblabs.io/api/v1/organizations//invites' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "new.user@example.com",
    "role": "MEMBER"
}'

Response Example

201 - Example 1

{
    "accepted_at": "2023-10-27T10:00:00Z",
    "created_at": "2023-10-26T14:00:00Z",
    "email": "invited.user@example.com",
    "expires_at": "2023-11-02T14:00:00Z",
    "id": "f6a7b8c9-d0e1-f234-5678-90abcdef0123",
    "invited_by": "b2c3d4e5-f6a7-8901-2345-67890abcdef0",
    "organization_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "role": "MEMBER",
    "status": "pending"
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Invitation successfully created and email sending initiated. Returns invite metadata (excluding token).

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

🔴500Server Error

Modified at 2025-05-03 01:39:03

Accept an organization invitation