Skip to content

Remove Dependent Info

Remove a dependent profile from a job.

This endpoint removes a previously provided dependent profile from a job's supporting item.

Endpoint

MethodUrl
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/remove-dependent-info

Path Parameters

job_id
string
required

The unique identifier of the job.

supporting_item_id
string
required

The unique identifier of the supporting item. Obtained from the job's checklist input.

Request Body

profile_id
string
required

The unique identifier of the dependent profile to remove.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/checklist/550e8400-e29b-41d4-a716-446655440000/remove-dependent-info' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5 "profile_id": "e7b513b9-d795-4475-9382-96710ca61622"
6}'

Response

Returns an empty response.

Errors

  • 403: Access denied - you are not allowed to remove the profile from this job
  • 404: Job not found - the specified job was not found
  • 404: Supporting item not found - the specified supporting item was not found
  • 404: Profile not found - the specified profile was not found on this job
  • 400: Invalid supporting item type - the supporting item is not of the right type for this action
Last updated on December 9, 2024