Update job
Updating jobs in Connecteam involves changing key attributes of an existing job identified by its unique job ID. This process allows you to adapt job configurations to meet your organization’s operational needs.
This method updates a single job in each request.
Good to know
Updating sub-jobs and jobs with nested sub-jobs is not currently supported, only 'regular' jobs can be updated.
Updating the assigned scheduler/time clock of the job is not is not currently supported
When updating a job, you need to specify the job ID and can adjust the following job details:
- jobId:The unique identifier of the job to update (specify in the path params)
- title: The title of the job.
- code: The code of the job.
- description: The description of the job.
- gps: The GPS data of the job, used if the job requires location tracking.
- assign:Assignment-related settings, allowing for detailed control over how and to whom the job is assigned. You can whether specify userIds, groupIds or both. We strongly recommend to specify 'both' in the type field.
- color: Optional. Defaults to #4B7AC5. The color representing the job. Must be one of the specified colors for uniformity across the platform.
Payload example for updating job request
{
"title": "Updated Title",
"code": "1344342",
"description": "This is a description for the update job.",
"gps": {
"address": "123 Sample St, Sample City, SC 12345",
"longitude": -75.123456,
"latitude": 39.123456
},
"assign": {
"type": "both",
"userIds": [],
"groupIds": [
1123124,
1234456
]
},
"color": "#4B7AC5"
}
Payload example for updating job response
{
"requestId": "abc123",
"data": {
"job": {
"jobId": "job_001",
"title": "Updated Title",
"code": "1344342",
"color": "#4B7AC5",
"description": "This is a description for the update job.",
"gps": {
"address": "456 Example Rd, Example City, EC 56789",
"longitude": -77.123456,
"latitude": 38.987654
},
"isDeleted": false,
"assign": {
"type": "users",
"userIds": ],
"groupIds": [
1123124,
1234456
]
},
"useParentData": false,
"parentId": "",
"subJobs": []
Updated 11 days ago
What’s Next