Update a Service

Use this endpoint to update selected fields on a service.

Overview

Send only the fields that should change. Editable fields are description, customerId, serviceTypeId, startTime, endTime, street, city, state, zip, notes, identifier, listId, startDate, endDate, isAllDay, isWindow, googleLat, googleLng, and duration. Other fields in the body are ignored.

customerId and serviceTypeId must reference records in the same organization as the service. The service must belong to the organization that owns the API key.

What's Next

  • Use GET /services/{id} to read the full service after the update.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Service ID.

Body Params
string

Short description of the work to perform.

string | null

Customer ID to attach to the service. Must belong to your organization.

string | null

Service type ID. Must belong to your organization.

string | null

Local start time when stored separately.

string | null

Local end time when stored separately.

string | null

Service street address.

string | null

Service city.

string | null

Service state or region.

string | null

Service postal code.

string | null

Service notes.

string | null

Job or service identifier.

string | null

List ID the service belongs to.

date-time | null

Scheduled service start date and time (ISO 8601). Send null to unschedule.

date-time | null

Scheduled service end date and time (ISO 8601). Send null to clear.

boolean | null

Whether the service is an all-day event.

boolean | null

Whether the service uses an arrival window.

number | null

Latitude for mapped workflows.

number | null

Longitude for mapped workflows.

integer | null

Expected duration in minutes.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json