POST
/
workspaces
/
{id}
/
members
Invite Member to Workspace
curl --request POST \
  --url https://{deploymentHost}/workspaces/{id}/members \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "<string>",
  "email": "jsmith@example.com",
  "role": "member"
}'
{
  "status": 200,
  "message": "",
  "data": {
    "member": {
      "id": "member_987654321",
      "user": {
        "id": "user_789123456",
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane.smith@acme.com",
        "profile_image_url": "https://cdn.acme.com/avatars/jane.jpg"
      },
      "role": "member",
      "joined_at": "2024-01-15T19:30:00Z"
    }
  },
  "session": {
    "signin_attempts": [],
    "signins": [
      {
        "id": "signin_987654321",
        "user_id": "user_456789123",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signup_attempts": [],
    "active_signin": {
      "id": "signin_987654321",
      "user_id": "user_456789123",
      "created_at": "2024-01-01T12:00:00Z"
    }
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Path Parameters

​
id
string
required

Workspace ID

Body

application/json

Response

200
application/json

Member invited successfully

The response is of type object.