Actions67
- Account Actions
- Asset Actions
- Asset Type Actions
- Base Data Actions
- Call Actions
- Contact Actions
- Contract Actions
- Crew Actions
- Document Actions
- Employee Actions
- Hours Actions
- Hour Type Actions
- Work Order Actions
Employee → Deactivate
AI-generatedSummary
Deactivate an employee record by sending a POST request with the employee's userCraft ID.
Inputs
- userCraft (required) — ID of the employee to deactivate.
- additionalFields — Optional fields such as userId and userActive that can be included in the request body.
- requestOptions — HTTP request configuration options like batching, timeout, proxy, and SSL validation.
Output shape
no body — success/failure only
The API returns an empty response on success; errors include a message field.
Examples
Example 1: Deactivate employee with ID '12345' using default options
userCraft: '12345', additionalFields: {}, requestOptions: {}
Example 2: Deactivate with batch processing of 100 items and custom timeout
userCraft: '12345', additionalFields: {userId: 'systemUser'}, requestOptions: {batching: {batchSize: 100, batchInterval: 500}, timeout: 15000}