Skip to content
Docs
Select language:English

/api/v1/me/report-schedules (PUT)

PUT
/api/v1/me/report-schedules
curl --request PUT \
  --url https://example.com/api/v1/me/report-schedules \
  --header 'Content-Type: application/json' \
  --data '{ "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "inventory", "cadence": "weekly" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
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)$/
kind
required
string
Allowed values: inventory insurance
cadence
required
string
Allowed values: weekly monthly

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)$/
locationName
required
string
kind
required
string
Allowed values: inventory insurance
cadence
required
string
Allowed values: weekly monthly
lastRunOn
required
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])))$/
lastError
required
string | null
Example
{
  "kind": "inventory",
  "cadence": "weekly"
}