Enroll candidate in pipeline
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"name": "<string>",
"send_email": true
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/"
payload = {
"email": "[email protected]",
"name": "<string>",
"send_email": True
}
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({email: '[email protected]', name: '<string>', send_email: true})
};
fetch('https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/', 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/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', name: '<string>', send_email: true})
};
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/"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"send_email\": true\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))
}{
"message": "Candidate already enrolled in this pipeline.",
"enrollment_id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
"status": "in_progress",
"current_stage": 1
}{
"message": "Candidate enrolled successfully.",
"enrollment_id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
"status": "in_progress",
"current_stage": 0
}{
"error": {
"message": "email is required",
"code": "MISSING_EMAIL"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "INVITE_QUOTA_EXCEEDED",
"message": "Monthly invite quota exceeded."
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Public API — Pipelines
Enroll candidate in pipeline
Required scope:
pipelines:write
Atomically enrolls a candidate and creates the stage-one invitation when the first stage is an assessment. Idempotent: returns HTTP 200 if the email is already enrolled. If invite quota is exhausted, returns INVITE_QUOTA_EXCEEDED and creates neither enrollment nor invite.
Responses
| Status | When |
|---|---|
201 | New enrollment |
200 | Candidate already enrolled |
400 | MISSING_EMAIL / validation |
403 | INVITE_QUOTA_EXCEEDED |
404 | Pipeline slug not found |
409 | ALREADY_INVITED for stage-one assessment |
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
/
Enroll candidate in pipeline
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"name": "<string>",
"send_email": true
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/"
payload = {
"email": "[email protected]",
"name": "<string>",
"send_email": True
}
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({email: '[email protected]', name: '<string>', send_email: true})
};
fetch('https://assess.praxicraft.com/api/v1/public/pipelines/{slug}/enroll/', 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/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', name: '<string>', send_email: true})
};
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/"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"send_email\": true\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))
}{
"message": "Candidate already enrolled in this pipeline.",
"enrollment_id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
"status": "in_progress",
"current_stage": 1
}{
"message": "Candidate enrolled successfully.",
"enrollment_id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
"status": "in_progress",
"current_stage": 0
}{
"error": {
"message": "email is required",
"code": "MISSING_EMAIL"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "INVITE_QUOTA_EXCEEDED",
"message": "Monthly invite quota exceeded."
}
}{
"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/jsonapplication/x-www-form-urlencodedmultipart/form-data
Last modified on September 5, 2026