Cancel an enrollment
May automatically promote a waitlisted participant and send domain notifications. Terminal-state cancellation is a no-op. Strict JSON body; maximum 16,384 UTF-8 bytes. Unknown query parameters and request fields are rejected. Requires enrollments.write.
/commands/cancel_enrollmentAuthorizationBearer token (soljio_sk_<secret>) · headerrequiredOrganization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.
Idempotency-KeystringrequiredPersist with the job and reuse for retries. Scoped to organization, token, command and API version. Different input with the same key returns 409. Supported automatic retry window: 24 hours.
application/jsonenrollment_idstringrequiredOpaque Soljio ID. Do not parse or synthesize.
Successful operation.
datacancel_enrollmentResultrequiredShow propertiesHide properties
enrollment_idstringrequiredOpaque Soljio ID. Do not parse or synthesize.
organization_idstringrequiredOpaque Soljio ID. Do not parse or synthesize.
okbooleanrequiredpromoted_enrollment_idstring | nullrequiredrequest_idstring<uuid>requiredidempotent_replaybooleanrequiredinvalid_request
errorobjectrequiredShow propertiesHide properties
codestringrequiredinvalid_requestmessagestringrequiredrequest_idstring<uuid>requiredunauthorized
errorobjectrequiredShow propertiesHide properties
codestringrequiredunauthorizedmessagestringrequiredrequest_idstring<uuid>requiredforbidden
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddenmessagestringrequiredrequest_idstring<uuid>requirednot_found
errorobjectrequiredShow propertiesHide properties
codestringrequirednot_foundmessagestringrequiredrequest_idstring<uuid>requiredmethod_not_allowed
errorobjectrequiredShow propertiesHide properties
codestringrequiredmethod_not_allowedmessagestringrequiredrequest_idstring<uuid>requiredconflict, idempotency_conflict
errorobjectrequiredShow propertiesHide properties
codestringrequiredconflictidempotency_conflictmessagestringrequiredrequest_idstring<uuid>requiredpayload_too_large
errorobjectrequiredShow propertiesHide properties
codestringrequiredpayload_too_largemessagestringrequiredrequest_idstring<uuid>requiredunsupported_media_type
errorobjectrequiredShow propertiesHide properties
codestringrequiredunsupported_media_typemessagestringrequiredrequest_idstring<uuid>requiredrate_limited
errorobjectrequiredShow propertiesHide properties
codestringrequiredrate_limitedmessagestringrequiredrequest_idstring<uuid>requiredinternal_error
errorobjectrequiredShow propertiesHide properties
codestringrequiredinternal_errormessagestringrequiredrequest_idstring<uuid>required