Assign a Supporting Client
Add a workspace member to a job as a supporting client.
Every job has a primary client — the CHAMPION client — but you can add additional clients to a job as supporting clients. A supporting client is a member of your workspace who should also be able to collaborate on the job, such as a spouse or a business partner.
Once added, the supporting client appears in the job's members array with a role of SUPPORTING and a type of CLIENT. See the Job Member Properties section for details.
The user you assign must already be a member of your workspace. Not every job type supports supporting clients; attempting to add one to an unsupported job type returns a BadRequest.
Endpoint
| Method | Url |
|---|---|
POST | v1.0/jobs/{job_id}/supporting-clients |
Url Parameters
ID of the job to add the supporting client to.
Sample Request
bashCopied1curl -X POST 'https://api.worklayer.com/v1.0/jobs/499d692d-67aa-4127-a45c-b9e27f54afad/supporting-clients' \2-H 'Authorization: Bearer {token}' \3-H 'Content-Type: application/json' \4-d '{5 "client_id": "4fec291a-fbb8-413a-86c0-f25f51c57ddc"6}'
Request Payload
The user ID of the workspace member to add to the job as a supporting client.
Response
The updated job belonging to your workspace, with the supporting client included in its members array. See the job resource page.
Sample Response
jsonCopied1{2 "id": "499d692d-67aa-4127-a45c-b9e27f54afad",3 "short_id": "TWQXJWMABW8",4 "name": "The name of the job",5 "description": "Tony Stark | 2021 | 1040",6 "status": "INFO_GATHERING",7 "create_time": "2021-04-28T13:45:25.781Z",8 "update_time": "2021-04-28T13:52:27.379Z",9 "total_amount": 10,10 "members": [11 {12 "role": "CHAMPION",13 "type": "CLIENT",14 "user_id": "a4feef24-00da-4340-8b7c-a532e0607fdd",15 "given_name": "Tony",16 "family_name": "Stark",17 "display_name": "Tony Stark"18 },19 {20 "role": "SUPPORTING",21 "type": "CLIENT",22 "user_id": "4fec291a-fbb8-413a-86c0-f25f51c57ddc",23 "given_name": "Pepper",24 "family_name": "Potts",25 "display_name": "Pepper Potts"26 }27 ]28}
Errors
Forbidden: API Client does not have permission to manage supporting clients on the job.Unauthorized: API Client does not have valid credentials.BadRequest: The job type does not support supporting clients, or there was a malformed request.NotFound: A job with the requestedjob_id, or a workspace member with the requestedclient_id, could not be found.