logo
WorkspacesInvite member
Workspaces

Invite member

Add an existing user to the workspace by email. The user must already have a SendKit account.

Requires a platform API key (sk_user_...). Workspace keys are rejected with 403. Requires invite permission: owner/admin can always invite, members can invite only if settings.allowMemberInvites is enabled.

curl -X POST "https://api.sendkit.ai/v1/workspaces/example_string/members" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "email": "newmember@example.com",
  "role": "member"
}'
{
  "success": true,
  "data": {
    "message": "Member added",
    "userId": "665d3e4f5a6b7c8d9e0f1a2b"
  }
}
POST
/v1/workspaces/{id}/members
POST
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Content-Typestring
Required

The media type of the request body

Options: application/json
emailstring
Required

Email address of the user to invite (must be a registered SendKit user)

Format: email
rolestring

Role to assign. Defaults to workspace's settings.defaultRole if omitted.

Options: admin, member
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

idstring
Required

Resource ID

Body

application/json
emailstring
Required

Email address of the user to invite (must be a registered SendKit user)

rolestring

Role to assign. Defaults to workspace's settings.defaultRole if omitted.

Allowed values:adminmember

Responses