Skip to main content
POST
Create Maintenance Agreement
Body raw (json)

Authorizations

x-api-key
string
header
required

Body

application/json
title
string
required
Maximum string length: 255
status_id
integer
required

Object type maintenance_agreement. Existing custom status id.

customer_id
integer | null

Required if is_template is false or not set. Existing customer id. Prohibited when is_template is true.

status_workflow_id
integer | null

Object type maintenance_agreement. Existing status workflow id.

customer_contact_id
integer | null

Existing customer contact id. Prohibited when is_template is true.

parent_invoice_id
integer | null

Not a template, and the agreement customer when a customer is set. Existing invoice id.

timezone
string | null

PHP timezone identifier.

start_time
integer | null

Timestamp. A date string is also accepted.

end_time
integer | null

Timestamp, same as or after start_time. A date string is also accepted.

job_location
string | null
Maximum string length: 255
agreement_notes
string | null
job_notes
string | null
is_template
boolean | null
asset_ids
integer[] | null

Array of existing asset ids.

settings
any[] | null

Stored as sent. No child-key rules.

tags
integer[] | null

Tag ids, or objects {"id": tag id}. Type must be maintenance_agreement.

assignments
object[] | null

Teams only. Each team is expanded to one assignment per member.

location_id
integer | null

A location of the agreement customer. Existing location id. Prohibited when is_template is true.

parent_job_id
integer | null

Not a template, and the agreement customer when a customer is set. Existing job id.

services_routines
object[]

Full list. An active agreement requires at least one. A scheduled routine cannot carry on_demand_generation_method. An on-demand routine cannot carry schedule_generation_method. Required if billing_routines is not set.

Maximum array length: 5
services_routine_overlaps
object[]

Dropped unless both indexed routines are scheduled and creation_method is automatic. One overlap per pair.

communication
object[]

Full list. Triggers omitted from the payload are deleted.

billing_routines
object[]

An active agreement requires exactly one.

Maximum array length: 1
customfields
object[] | null

Array of custom fields.

template_id
integer | null

Existing maintenance agreement template id.

engage_call_to_records
object[]

Create only. At most one item may be the primary call.

Response

200 - application/json

Successful response

error
boolean

false when the request succeeds.

Example:

false

response
object