Request
POST https://app.datumforms.com/api/developer-api
Operation: recruitment.stop
Permissions: recruitment:stop.
Pause new recruitment for data.study_id; existing reservation rules still apply.
Send operation as a query parameter for GET, or a top-level JSON member for POST. Every POST also needs idempotency_key (8–100 permitted characters). Fields marked data belong inside the JSON data object.
| Parameter | Location | Type | Required | Meaning |
|---|---|---|---|---|
study_id |
data | string | Yes | Study UUID from the recruitment study result. |
Response
Successful results contain success: true plus these operation fields. Fields returned by shared form and resource services retain their normal definitions.
| Field | Type or shape |
|---|---|
success |
boolean |
See schemas for answer cells, responses and collection details. Use IDs from your project: groups.list returns group IDs, surveys.get returns page/question IDs, and responses.list returns response IDs and revisions.
Examples
Set DATUMFORMS_API_KEY. Replace example IDs with IDs returned by the preceding reads. Replace docs-run-001 with your persisted job identity. Write examples perform the named operation; keep the exact request and identity unchanged when retrying. JavaScript and Python examples use the downloadable clients.
cURL
curl --fail-with-body 'https://app.datumforms.com/api/developer-api' \
-H "Authorization: Bearer $DATUMFORMS_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"operation":"recruitment.stop","data":{"study_id":"11111111-1111-4111-8111-111111111111"},"idempotency_key":"docs-run-001:recruitment-stop"}'
JavaScript
import { request } from './client.mjs';
const result = await request("POST", {
"operation": "recruitment.stop",
"data": {
"study_id": "11111111-1111-4111-8111-111111111111"
},
"idempotency_key": "docs-run-001:recruitment-stop"
});
console.log(JSON.stringify(result, null, 2));
Python
import json
from client import request
payload = json.loads('{"operation": "recruitment.stop", "data": {"study_id": "11111111-1111-4111-8111-111111111111"}, "idempotency_key": "docs-run-001:recruitment-stop"}')
result = request('POST', payload)
print(json.dumps(result, indent=2))
Pagination and errors
This operation does not use cursor pagination. For 400, check required values and types; for 401, check authentication; for 403, check permissions and project scope; for 404, check the resource ID. For 409, resolve the current revision or review conflict. Retry uncertain writes with the identical request and original key. See error recovery and the operation index.