Submit a draft for approval
POST /supplier-assessment-templates/{templateId}/submit
Scope supplier_template:write Plan Growth+
Send a draft to the people who can publish it. The draft’s revision is required (in the body or as If-Match; otherwise 400 VALIDATION_FAILED), so an approver is asked about exactly the version the caller saw. note (at most 500 characters) is shown to the approver. The whole draft is validated first: if it has problems nothing changes, the status stays draft and the answer is 422 TEMPLATE_INVALID with the list in error.args.violations (the same list as validateSupplierTemplate): for example a choice question with fewer than two options, or a question without English text. A submitted version is frozen until the submitter withdraws it (withdrawSupplierTemplate) or an approver sends it back. Publishing it as the next version is a person’s decision and is refused to tokens. The built-in questionnaire cannot be submitted (403 BUILTIN_IMMUTABLE). Structural write: 30 per token and hour. Requires the supplier_template:write scope (or a signed-in Owner, Manager or Contributor session).
Example
curl -X POST "https://api.autociso.io/api/v1/supplier-assessment-templates/<templateId>/submit" \
-H "Authorization: Bearer <your-api-token>" \
-H "Content-Type: application/json" \
-d '{"revision":3,"note":"Added the encryption question."}'import requests
response = requests.post(
"https://api.autociso.io/api/v1/supplier-assessment-templates/<templateId>/submit",
headers={"Authorization": "Bearer <your-api-token>", "Content-Type": "application/json"},
json={
"revision": 3,
"note": "Added the encryption question.",
},
)
print(response.json())const response = await fetch("https://api.autociso.io/api/v1/supplier-assessment-templates/<templateId>/submit", {
method: "POST",
headers: { "Authorization": "Bearer <your-api-token>", "Content-Type": "application/json" },
body: JSON.stringify({
"revision": 3,
"note": "Added the encryption question."
}),
});
console.log(await response.json());Response 200
{
"data": {
"templateId": "satpl_1hgyun41rx48",
"templateKey": "tpl_1hgyun41rx49",
"version": 0,
"titleKey": "",
"title": {
"en": "Example vendor security review"
},
"modes": [],
"source": "authored",
"status": "submitted",
"active": false,
"questionCount": 0,
"revision": 3,
"createdAt": "2026-10-09T08:15:00Z",
"updatedAt": "2026-10-09T08:20:00Z",
"sections": [
{
"sectionId": "sect_1hgyun41rx4a",
"titleKey": "",
"title": {
"en": "Governance"
},
"order": 1,
"questions": []
}
],
"limits": {
"maxSections": 20,
"maxQuestionsPerSection": 50,
"maxQuestionsPerTemplate": 300,
"maxOptionsPerQuestion": 12
},
"permissions": {
"canEdit": false,
"canSubmit": false,
"canWithdraw": true,
"canReject": false,
"canPublish": false,
"canSetDefault": false,
"canArchive": false,
"canDelete": false,
"publishBlockedReason": null
}
}
}Path parameters
templateIdstring requiredQuestionnaire document id (satpl_...), orsatpl_builtin_supplier_security_privacy_v1for the built-in one.
Header parameters
If-MatchstringThe draft revision asW/"<revision>", from the ETag header. Wins over arevisionin the body. A write on an older revision fails with 409 STALE_REVISION.
Request body
revisionintegerThe draft revision; or send it as If-Match.notestringShown to the approver.
Returns
The data field of the standard { data, error, meta } envelope:
templateIdstring requiredtemplateKeystring requiredShared by all versions of the questionnaire.versioninteger required0 for an open draft.titleKeystring requireddescriptionKeystringtitleobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.enstring requiredrustringhestring
descriptionobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.enstring requiredrustringhestring
modesarray of string requiredsourcestring"builtin" | "authored"statusstringdraft and submitted are open (editable or awaiting approval); published is the live version; archived is retired."draft" | "submitted" | "published" | "archived"activeboolean requiredisDefaultbooleanquestionCountintegerrevisionintegerSend with an edit; changes on every structural edit.contentHashstringclonedFromKeystringclonedFromVersionintegerparentVersionintegerpublishedAtstring (date-time)publishedBystringcreatedAtstring (date-time) requiredupdatedAtstring (date-time) requiredcreatedBystringupdatedBystringlastEditedBystringlastEditedAtstring (date-time)submittedBystringsubmittedAtstring (date-time)submitterNotestringrejectedBystringrejectedAtstring (date-time)rejectionReasonstringsectionsarray of object requiredsectionIdstring requiredtitleKeystring requiredtitleobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.Show 3 propertiesHide 3 properties { en, ru, he }
enstring requiredrustringhestring
orderinteger requiredquestionsarray of object requiredShow 19 propertiesHide 19 properties { questionId, textKey, helpKey, answerType, … }
questionIdstring requiredtextKeystring requiredBuilt-in text key; authored questions carrytextinstead.helpKeystringanswerTypestring required"text" | "email" | "phone" | "textarea" | "single_select" | "multi_select"requiredboolean requiredmodesarray of string requireddomainstring required"" | "governance" | "privacy" | "access" | "operations" | "resilience" | "supply_chain" | "contractual"syncTargetstringevidenceHintKeystringoptionsarray of objectShow 8 propertiesHide 8 properties { optionId, labelKey, notApplicable, label, … }
optionIdstring requiredlabelKeystring requiredBuilt-in text key; authored options carrylabelinstead.notApplicablebooleanlabelobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.Show 3 propertiesHide 3 properties { en, ru, he }
enstring requiredrustringhestring
riskValueintegerScoring: 0 (no risk) to 4.findingSeveritystring"info" | "low" | "medium" | "high" | "critical"findingKeystringfindingobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.Show 3 propertiesHide 3 properties { en, ru, he }
enstring requiredrustringhestring
requiresVendorTypesarray of stringallowNotApplicablebooleanrequiresResponsesarray of objectShow 2 propertiesHide 2 properties { questionId, anyOption }
questionIdstring requiredanyOptionarray of string required
textobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.Show 3 propertiesHide 3 properties { en, ru, he }
enstring requiredrustringhestring
helpobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.Show 3 propertiesHide 3 properties { en, ru, he }
enstring requiredrustringhestring
evidenceHintobjectText per locale.enis required;ruandhefall back toenwhen blank. At most 500 characters per locale (2000 for a description); HTML is rejected.Show 3 propertiesHide 3 properties { en, ru, he }
enstring requiredrustringhestring
authoredbooleanweightintegerScoring weight.controlIdsarray of string
limitsobject requiredThe structural caps the server enforces.maxSectionsinteger requiredmaxQuestionsPerSectioninteger requiredmaxQuestionsPerTemplateinteger requiredmaxOptionsPerQuestioninteger required
permissionsobjectWhat the caller may do with this version right now.canEditboolean requiredcanSubmitboolean requiredcanWithdrawboolean requiredcanRejectboolean requiredcanPublishboolean or null requiredcanSetDefaultboolean requiredcanArchiveboolean requiredcanDeleteboolean requiredpublishBlockedReasonstring or null required
Errors
| Status | Code | Retry | Meaning |
|---|---|---|---|
| 400 | VALIDATION_FAILED |
no | The JSON body does not match the request schema, or the revision is missing where required. code VALIDATION_FAILED. |
| 401 | INVALID_TOKEN |
no | Missing (UNAUTHORIZED) or invalid, expired or revoked (INVALID_TOKEN) token. |
| 402 | FEATURE_GATED |
no | The tenant plan does not include supply chain security. code FEATURE_GATED; args.feature, args.minTier, args.minTierName. |
| 403 | INSUFFICIENT_SCOPE |
no | The token lacks supplier_template:write (INSUFFICIENT_SCOPE), has no accountable person (FORBIDDEN: this principal cannot edit questionnaires), or the target is the built-in questionnaire (BUILTIN_IMMUTABLE). |
| 404 | NOT_FOUND |
no | Unknown or foreign-tenant questionnaire, version or clone source. code NOT_FOUND. |
| 409 | ALREADY_SUBMITTED |
no | The version cannot be submitted. code STALE_REVISION (the draft changed since the revision sent), ALREADY_SUBMITTED, NOT_A_DRAFT (published) or TEMPLATE_ARCHIVED; args.current holds the document. |
| 413 | PAYLOAD_TOO_LARGE |
no | The JSON body exceeds the size limit. code PAYLOAD_TOO_LARGE. |
| 422 | TEMPLATE_INVALID |
no | The draft fails validation and was not submitted. code TEMPLATE_INVALID; args.violations lists the problems. |
| 429 | RATE_LIMITED |
yes | Too many failed authentication attempts from this address, or the token used its hourly write budget (30 structural, 120 field edits). code RATE_LIMITED; wait Retry-After seconds, also in error.args.retryAfterSeconds. |
| 500 | DB_ERROR |
no | Unexpected server error. code DB_ERROR; quote error.id to support. |
| 503 | BILLING_UNAVAILABLE |
yes | Billing is temporarily unavailable, so the plan could not be checked. code BILLING_UNAVAILABLE. Retry later. |
Was this page helpful?