Create a Service

Use this endpoint to create a service in your organization.

Overview

A service represents work that needs to be scheduled, assigned, tracked, documented, and often invoiced. At minimum, provide a description; include customer, status, service type, scheduling, address, and recurrence fields when those details are known.

New services are scoped to the organization that owns the API key.

What's Next

  • Use GET /services/{id} to confirm the service details after creation.
  • Use GET /statuses and GET /service-types to map workflow and work-type IDs before creating services.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Short description of the work to perform.

string

Customer ID to attach to the service.

string

Optional job or service identifier.

string

Initial workflow status ID.

string

Service type ID that categorizes the work.

string

Technician ID to assign when known.

date-time

Scheduled service start date and time.

date-time

Scheduled service end date and time.

string

Local start time when stored separately.

string

Local end time when stored separately.

integer

Expected duration in minutes.

boolean

Set true for an all-day service.

boolean

Set true when the service uses an arrival window.

string

Service street address.

string

Service city.

string

Service state or region.

string

Service postal code.

number

Latitude for mapped workflows when available.

number

Longitude for mapped workflows when available.

string

Recurring service frequency when creating a recurring schedule.

integer

Interval between recurring service instances.

string

Recurring service pattern type.

integer

Number of recurring instances to create.

date-time

End date for the recurring service schedule.

string

Comma-separated days used by the recurrence pattern.

claimsSync
object

Optional claims sync payload for Xactimate-style service creation.

serviceContacts
array of objects

Optional job contacts to create with the service.

serviceContacts
Responses

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