Skip to main content
POST
/
organizations
/
{id}
/
invitations
Invite member
curl --request POST \
  --url https://api.wacht.dev/organizations/{id}/invitations \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --cookie session_id= \
  --data email=newuser@example.com \
  --data role_id=123456789012345678 \
  --data workspace_id=987654321098765432 \
  --data workspace_role_id=555555555555555555
{
  "id": "666666666666666666",
  "organization_id": "123456789012345678",
  "email": "newuser@example.com",
  "token": "inv_token_abc123",
  "status": "pending",
  "expires_at": "2024-01-22T10:30:00Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

session_id
string
cookie
required

Session-based authentication using cookies

Path Parameters

id
string<uint64>
required

Organization ID

Body

application/x-www-form-urlencoded
email
string<email>
required

Email address of the user to invite

Example:

"newuser@example.com"

role_id
string<uint64>

Organization role to assign

Example:

"123456789012345678"

workspace_id
string<uint64>

Specific workspace to invite to

Example:

"987654321098765432"

workspace_role_id
string<uint64>

Workspace role to assign

Example:

"555555555555555555"

Response

Invitation sent successfully

id
string<uint64>

Invitation ID

Example:

"666666666666666666"

organization_id
string<uint64>

Organization ID

Example:

"123456789012345678"

email
string<email>

Invitee email

Example:

"newuser@example.com"

token
string

Invitation token

Example:

"inv_token_abc123"

status
enum<string>

Invitation status

Available options:
pending,
accepted,
discarded
Example:

"pending"

expires_at
string<date-time>

Expiration time

Example:

"2024-01-22T10:30:00Z"

created_at
string<date-time>
updated_at
string<date-time>