Soft delete a job

post

https://integrate.rooflink.com/roof_link_endpoints/api/light/jobs/{id}/soft_delete/

Marks a job as deleted by setting the date_deleted timestamp and deleted_by employee reference, without removing it from the database. The job will be excluded from most queries but can be restored using the undelete endpoint. The authenticated employee must have permission to delete the job, typically requiring admin privileges or being the job owner. If a comment is provided, a note will be automatically created on the job with the message 'Job Deleted: {comment}' for audit trail purposes. This is the preferred method for removing jobs as it maintains audit history and allows for recovery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Job soft deleted successfully. Returns the job ID and deletion timestamp for confirmation.

400Bad Request. The request contains invalid data or missing required fields. Check the field_errors in the response for specific validation failures.

401Unauthorized. Authentication credentials were not provided or are invalid. The request must include valid authentication tokens to access this endpoint.

403Forbidden. The authenticated user does not have permission to delete this job. This typically means the user is not an admin and does not have the can_delete_job permission for this specific job.

404Not Found. The requested job does not exist or the authenticated user does not have access to it (e.g., job belongs to a different company).

429Too Many Requests. The client has exceeded the rate limit for this endpoint. Wait for the specified time period before making additional requests.

503Service Unavailable. The API rate limits for all public endpoints have been exceeded, or the service is temporarily down for maintenance. Try again later.