Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Accept Invitation

Accept a workspace invitation. Usable by authenticated users only.

put/api/v1/workspaces/invitations/{invite_code}/accept

Path parameters

invite_codestring required

An opaque string representing an invite code. This invitation code is sent to a user via email and is exclusive for the user.

Example:26d332457f16dc67f18385194be148f62c2b4317

Response

Successful Response

inviter_idstring required

ID of the user user who sent the invitation

user_emailstring required

The invited person's email.

workspace_idstring required

ID of the workspace

role'ADMIN' | 'MEMBER' | 'GUEST' required

Role of the user inside the workspace

idstring

The ID of the invitation

Example response

{
  "inviter_id": "1029384756",
  "user_email": "foo@example.com",
  "workspace_id": "12345",
  "id": "234"
}