Bulk create invitations
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidates": [
{
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"external_id": "<string>"
}
],
"expires_days": 7,
"send_email": false,
"extra_time_percent": 0,
"tags": [
"<string>"
]
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/"
payload = {
"candidates": [
{
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"external_id": "<string>"
}
],
"expires_days": 7,
"send_email": False,
"extra_time_percent": 0,
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidates: [
{
email: '[email protected]',
name: '<string>',
role: '<string>',
external_id: '<string>'
}
],
expires_days: 7,
send_email: false,
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidates: [
{
email: '[email protected]',
name: '<string>',
role: '<string>',
external_id: '<string>'
}
],
expires_days: 7,
send_email: false,
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/"
payload := strings.NewReader("{\n \"candidates\": [\n {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"expires_days\": 7,\n \"send_email\": false,\n \"extra_time_percent\": 0,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"invited": [
{
"email": "[email protected]",
"invite_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"invite_url": "https://assess.praxicraft.com/take/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
],
"skipped": [
{
"email": "[email protected]",
"reason": "already invited"
},
{
"email": "",
"reason": "missing email"
}
]
}Public API — Invitations
Bulk create invitations
Required scope:
invitations:write
Creates invitations for multiple candidates in one request. Duplicate emails are returned in skipped (reason: already invited). Rows with empty email are skipped (missing email). Processing stops when the monthly invite quota is reached mid-batch (invite quota reached for this billing cycle). Also subject to a dedicated 20 requests/hour bulk-invite rate limit (in addition to the plan write bucket).
Responses
| Status | Code | When |
|---|---|---|
201 | — | Batch processed — see invited and skipped arrays |
400 | ASSESSMENT_NOT_ACTIVE | Assessment is draft or archived |
400 | INVALID_INPUT | candidates missing or empty |
403 | INVITE_QUOTA_EXCEEDED | No quota remaining before any invites are created |
404 | — | Assessment slug not found |
429 | RATE_LIMITED | Plan write bucket or bulk-invite 20/hour cap exceeded |
Authentication & rate limits (all endpoints)
| Status | Code | When |
|---|---|---|
401 | INVALID_API_KEY | Missing or invalid bearer token |
401 | EXPIRED_API_KEY | API key past its optional expires_at |
403 | INSUFFICIENT_SCOPE | API key lacks the required scope for this operation |
403 | IP_NOT_ALLOWED | Client IP is outside this key’s CIDR allowlist |
429 | RATE_LIMITED | Rate limit exceeded — plan-tiered reads/writes per organisation per hour |
POST
/
api
/
v1
/
public
/
assessments
/
{slug}
/
invites
/
bulk
/
Bulk create invitations
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidates": [
{
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"external_id": "<string>"
}
],
"expires_days": 7,
"send_email": false,
"extra_time_percent": 0,
"tags": [
"<string>"
]
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/"
payload = {
"candidates": [
{
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"external_id": "<string>"
}
],
"expires_days": 7,
"send_email": False,
"extra_time_percent": 0,
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidates: [
{
email: '[email protected]',
name: '<string>',
role: '<string>',
external_id: '<string>'
}
],
expires_days: 7,
send_email: false,
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidates: [
{
email: '[email protected]',
name: '<string>',
role: '<string>',
external_id: '<string>'
}
],
expires_days: 7,
send_email: false,
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/bulk/"
payload := strings.NewReader("{\n \"candidates\": [\n {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"expires_days\": 7,\n \"send_email\": false,\n \"extra_time_percent\": 0,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"invited": [
{
"email": "[email protected]",
"invite_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"invite_url": "https://assess.praxicraft.com/take/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
],
"skipped": [
{
"email": "[email protected]",
"reason": "already invited"
},
{
"email": "",
"reason": "missing email"
}
]
}Authorizations
Organisation API key created in Assess → Developer → API Keys. Format: Bearer ct_live_<your-key> (live) or Bearer ct_test_<your-key> (test). Optional per-key CIDR allowlists return 403 IP_NOT_ALLOWED.
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Last modified on September 5, 2026