Skip to content
XOS Developers

Delete an onboarding requirement

Opportunities module

DELETE/onboarding-requirements/{id}onboardingRequirements.delete

A requirement of the onboarding packet, by role type and jurisdiction. Soft-deletes the onboarding requirement: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.gateway.write.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

onboardingRequirements.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the onboarding requirement.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/onboarding-requirements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.onboardingRequirements.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.onboarding_requirements.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos onboarding-requirements delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f