Hide
Google Maps Coordinate API

Jobs: update

Requires authorization

Updates a job. Only the fields that are sent in the request are updated. Try it now.

Request

HTTP request

PUT https://www.googleapis.com/coordinate/v1/teams/teamId/jobs/jobId

Parameters

Parameter name Value Description
Path parameters
jobId unsigned long The job's unique ID, as assigned by the API.
teamId string
The team ID. Your team ID is part of the Maps Coordinate web interface's URL:

https://coordinate.google.com/f/team_id

It is a 22-character string that may include letters, numbers, hypens, and underscores.
Optional query parameters
address string The job's human-readable address as newline (Unix) separated string.
assignee string The assignee's email address. The assignee must exist as a mobile worker on your team.
customField string Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.
customerName string The customer's name.
customerPhoneNumber string The customer's phone number.
lat double The latitude coordinate of this job's location.
lng double The longitude coordinate of this job's location.
note string Job notes, as a newline (Unix) separated string.
progress string The current progress state of the job.

Acceptable values are:
  • "COMPLETED": Completed
  • "IN_PROGRESS": In progress
  • "NOT_ACCEPTED": Not accepted
  • "NOT_STARTED": Not started
  • "OBSOLETE": Obsolete
title string The job title.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/coordinate

Request body

In the request body, supply a Jobs resource with the following properties:

Property name Value Description Notes
Optional Properties
jobChange[].state.assignee string Email address of the assignee, or the string "DELETED_USER" if the account is no longer available. writable
jobChange[].state.customFields nested object Custom fields. writable
jobChange[].state.customerName string Customer name. writable
jobChange[].state.customerPhoneNumber string The customer's phone number. writable
jobChange[].state.location nested object The job location object. writable
jobChange[].state.note[] list Note added to the job. writable
jobChange[].state.progress string Job progress. Possible values are NOT_ACCEPTED, NOT_STARTED, IN_PROGRESS, COMPLETED, or OBSOLETE.

Acceptable values are:
  • "COMPLETED"
  • "IN_PROGRESS"
  • "NOT_ACCEPTED"
  • "NOT_STARTED"
  • "OBSOLETE"
writable
jobChange[].state.title string Job title. writable
state.assignee string Email address of the assignee, or the string "DELETED_USER" if the account is no longer available. writable
state.customFields nested object Custom fields. writable
state.customerName string The customer's name. writable
state.customerPhoneNumber string Customer phone number. No formatting or sanitizing takes place on this string. writable
state.location nested object The job location object. writable
state.note[] list Note added to the job. writable
state.progress string Job progress. Possible values are NOT_ACCEPTED, NOT_STARTED, IN_PROGRESS, COMPLETED, or OBSOLETE.

Acceptable values are:
  • "COMPLETED"
  • "IN_PROGRESS"
  • "NOT_ACCEPTED"
  • "NOT_STARTED"
  • "OBSOLETE"
writable
state.title string The job's title. writable

Response

If successful, this method returns a Jobs resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.