Bulk enroll candidates
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/bulk/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidates": [
{
"email": "[email protected]",
"name": "<string>"
}
],
"send_email": true,
"expires_days": 7,
"file": "<string>"
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/bulk/"
payload = {
"candidates": [
{
"email": "[email protected]",
"name": "<string>"
}
],
"send_email": True,
"expires_days": 7,
"file": "<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>'}],
send_email: true,
expires_days: 7,
file: '<string>'
})
};
fetch('https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/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/pipelines/{slug}/enroll/bulk/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidates: [{email: '[email protected]', name: '<string>'}],
send_email: true,
expires_days: 7,
file: '<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/pipelines/{slug}/enroll/bulk/"
payload := strings.NewReader("{\n \"candidates\": [\n {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\"\n }\n ],\n \"send_email\": true,\n \"expires_days\": 7,\n \"file\": \"<string>\"\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))
}{
"enrolled": [
{
"email": "[email protected]",
"enrollment_id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890"
}
],
"skipped": [
{
"email": "[email protected]",
"reason": "already_enrolled"
}
],
"errors": [],
"enrolled_count": 1,
"skipped_count": 1,
"error_count": 0
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"message": "Invalid or revoked API Key.",
"code": "INVALID_API_KEY"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Public API — Pipelines
Bulk enroll candidates
Required scope:
pipelines:write
Bulk-enroll candidates. Same atomicity rules as single enroll. Capped like bulk invite (20/hour).
Responses
| Status | When |
|---|---|
200 | Batch result with enrolled/skipped/errors |
404 | Pipeline slug not found |
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
/
pipelines
/
{slug}
/
enroll
/
bulk
/
Bulk enroll candidates
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/bulk/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidates": [
{
"email": "[email protected]",
"name": "<string>"
}
],
"send_email": true,
"expires_days": 7,
"file": "<string>"
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/bulk/"
payload = {
"candidates": [
{
"email": "[email protected]",
"name": "<string>"
}
],
"send_email": True,
"expires_days": 7,
"file": "<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>'}],
send_email: true,
expires_days: 7,
file: '<string>'
})
};
fetch('https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/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/pipelines/{slug}/enroll/bulk/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidates: [{email: '[email protected]', name: '<string>'}],
send_email: true,
expires_days: 7,
file: '<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/pipelines/{slug}/enroll/bulk/"
payload := strings.NewReader("{\n \"candidates\": [\n {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\"\n }\n ],\n \"send_email\": true,\n \"expires_days\": 7,\n \"file\": \"<string>\"\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))
}{
"enrolled": [
{
"email": "[email protected]",
"enrollment_id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890"
}
],
"skipped": [
{
"email": "[email protected]",
"reason": "already_enrolled"
}
],
"errors": [],
"enrolled_count": 1,
"skipped_count": 1,
"error_count": 0
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"message": "Invalid or revoked API Key.",
"code": "INVALID_API_KEY"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}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/jsonmultipart/form-dataapplication/x-www-form-urlencoded
Last modified on September 5, 2026