POST
/
v3
/
workspaces
/
{workspaceId}
/
invitations
Create Workspace Invitation
curl --request POST \
  --url http://127.0.0.1:3333/v3/workspaces/{workspaceId}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "type": "ADMIN"
}
'
{
  "invitation": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "workspaceId": "<string>",
    "type": "ADMIN"
  },
  "member": {
    "userId": "<string>",
    "workspaceId": "<string>",
    "role": "ADMIN",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "email": "<string>",
    "image": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

workspaceId
string
required

Body

application/json
email
string<email>
required
type
enum<string>
required
Available options:
ADMIN,
MEMBER,
GUEST

Response

200 - application/json

Default Response

invitation
object
member
object