Apprentice API Guides
This section contains the Apprentice API endpoints and a brief description of the functionality provided by each endpoint.
Endpoints
Delete Apprentice
Deletes a specific apprentice record from the system by their unique ID.
DANGER
- Irreversible Action: Deleting an apprentice is permanent and cannot be undone.
- Refund Policy: If the apprentice record is older than 90 days, no refunded token will be issued.
- URL:
/apprentice/:apprenticeId - Method:
DELETE
Path Parameters
| Parameter | Type | Description |
|---|---|---|
apprenticeId | string | The unique identifier of the apprentice to delete. |
Responses
🟢 200 OK
Returned if the apprentice is deleted within 90 days of creation. A refund is automatically processed.
json
{
"success": true,
"message": "Apprentice deleted successfully. A token refund has been issued.",
}🟢 204 No Content
Returned if the apprentice is deleted after 90 days of creation. The deletion is successful and no refund is given.
ACE360 Connect Documentation