Skip to content
Docs
Select language:English

/api/v1/schedules/{id} (PATCH)

PATCH
/api/v1/schedules/{id}
curl --request PATCH \
  --url https://example.com/api/v1/schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "everyMonths": 1, "everyUnits": "example", "meterId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dueOn": "2026-04-15", "leadDays": 1, "leadUnits": "example", "anchorOn": "2026-04-15", "anchorValue": "example", "active": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 120 characters
everyMonths
Any of:
integer
>= 1 <= 600
everyUnits
Any of:
string
/^\d{1,11}(\.\d{1,3})?$/
meterId
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
dueOn
Any of:
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
leadDays
integer
<= 365
leadUnits
Any of:
string
/^\d{1,11}(\.\d{1,3})?$/
anchorOn
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
anchorValue
Any of:
string
/^\d{1,11}(\.\d{1,3})?$/
active
boolean
Examplegenerated
{
  "name": "example",
  "everyMonths": 1,
  "everyUnits": "example",
  "meterId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "dueOn": "2026-04-15",
  "leadDays": 1,
  "leadUnits": "example",
  "anchorOn": "2026-04-15",
  "anchorValue": "example",
  "active": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
subject
required
object
type
required
string
Allowed values: thing place location
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
path
required
string
shortCode
string | null
name
required
string
everyMonths
required
number | null
everyUnits
required
string | null
meter
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
label
required
string
unit
required
string
dueOn
required
string | null
leadDays
required
number
leadUnits
required
string | null
anchorOn
required
string
anchorValue
required
string | null
next
required
object
dueOn
required
string | null
dueValue
required
string | null
state
required
string
Allowed values: upcoming due overdue done
basis
required
string
Allowed values: months units both once
snoozedUntil
required
string | null
snoozedUntilValue
required
string | null
skipNext
required
boolean
active
required
boolean
lastService
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
servicedOn
required
string
rowVersion
required
number
Example
{
  "subject": {
    "type": "thing"
  },
  "next": {
    "state": "upcoming",
    "basis": "months"
  }
}