Create invitation

POST

/invitations

Invitations

Creates a new invitation to join the workspace with a specific role

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Invitation created successfully

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/invitations' \
--header 'x-external-user-id;' \
--header 'x-idempotency-key;' \
--header 'x-user-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "firstName": "string",
    "lastName": "string",
    "nickname": "string",
    "lang": "aa",
    "role": "member",
    "message": "string",
    "expiresInDays": 7
}'

Response Example

{
    "invitationId": "FUMzPf00hz_kcj2R2Hlzq",
    "email": "user@example.com",
    "firstName": "string",
    "lastName": "string",
    "nickname": "string",
    "lang": "aa",
    "role": "member",
    "status": "PENDING",
    "invitedBy": "string",
    "expiresAt": "2019-08-24T14:15:22.123Z",
    "acceptedAt": "2019-08-24T14:15:22.123Z",
    "acceptedByPrincipalId": "string",
    "message": "string",
    "emailRequested": true,
    "emailSentAt": "2019-08-24T14:15:22.123Z",
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-06-15 16:41:21

List invitations

Get invitation by ID