Add or create member
Add a user to the workspace by email.
- If a user with this email already exists, they are added to the workspace (any
passwordin the body is ignored — existing accounts are never modified). - If no user exists and a
passwordis supplied, a new login-capable account is created (pre-verified) with that password and added to the workspace. - If no user exists and no
passwordis supplied, returns404(unchanged legacy behaviour).
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" \
-d '{
"email": "newmember@example.com",
"role": "member",
"password": "s3curePass1"
}'
import requests
import json
url = "https://api.sendkit.ai/v1/workspaces/example_string/members"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
data = {
"email": "newmember@example.com",
"role": "member",
"password": "s3curePass1"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/workspaces/example_string/members", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"email": "newmember@example.com",
"role": "member",
"password": "s3curePass1"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"email": "newmember@example.com",
"role": "member",
"password": "s3curePass1"
}`)
req, err := http.NewRequest("POST", "https://api.sendkit.ai/v1/workspaces/example_string/members", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/workspaces/example_string/members')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request.body = '{
"email": "newmember@example.com",
"role": "member",
"password": "s3curePass1"
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"message": "Member added",
"userId": "665d3e4f5a6b7c8d9e0f1a2b",
"created": false
}
}
{
"success": true,
"data": {
"message": "Member created and added",
"userId": "665d3e4f5a6b7c8d9e0f1a2b",
"created": true
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
/v1/workspaces/{workspaceId}/membersTarget server for requests. Edit to use your own host.
Platform API key (sk_user_...) or Workspace API key (sk_...)
Workspace ID
The media type of the request body
Email address of the user to add. Need not be a registered user if password is provided.
Role to assign. Defaults to workspace's settings.defaultRole if omitted.
Only used when no account exists for email. Creates a new user with this password (min 8 chars, at least one letter and one number). Ignored if the user already exists.
Optional display name for a newly created user. Defaults to the email local-part.
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Path Parameters
Workspace ID
Body
Email address of the user to add. Need not be a registered user if password is provided.
Role to assign. Defaults to workspace's settings.defaultRole if omitted.
adminmemberOnly used when no account exists for email. Creates a new user with this password (min 8 chars, at least one letter and one number). Ignored if the user already exists.
Optional display name for a newly created user. Defaults to the email local-part.