API reference

Reminders

Resource reminders

A reminder fires at a date on a property. Mark it actionable to surface it as a todo in the Properly apps, and attach jobRequestSettings to pre-fill the job it should turn into.

Create a reminder

POST /v1/reminders 201 Created x-api-key

Creates a reminder. Actionable reminders surface as todos in the Properly apps.

Request body
Field	Type	Required	Notes
`title`	`string`	Required	—
`date`	`date-time`	Required	When the reminder fires.
`propertyId`	`string`	One of	One of propertyId or sourcePropertyId identifies the property.
`sourcePropertyId`	`string`	One of	Your property id.
`sourceBookingId`	`string`	Optional	Ties the reminder to a booking.
`sourceId`	`string`	Optional	Your id for the reminder.
`actionable`	`boolean`	Optional	Actionable reminders surface as todos in the apps.
`checklists`	`object[]`	Optional	Items { "checklistId": string }.
`jobRequestSettings`	`object`	Optional	Pre-fills the job-request send flow. See Job request settings.

Job request settings

Job request settings
Field	Type	Required	Notes
`time`	`object`	Optional	See Job time.
`offeredPrice`	`number`	Optional	0 or more.
`offeredPriceCurrency`	`string`	Optional	—
`message`	`string`	Optional	3–500 chars.

Job time

Job time
Field	Type	Required	Notes
`type`	`string`	Required	fixed or flexible.
`startTime`	`date-time`	Required	—
`endTime`	`date-time`	Optional	—
`durationInHours`	`integer`	Optional	1–999. Omit it rather than sending 0.
`durationInMinutes`	`integer`	Optional	1–999. Omit it rather than sending 0.

Request

curl -X POST https://platform.getproperly.com/v1/reminders \
  -H "x-api-key: $PROPERLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Send turnover job",
    "date": "2026-10-07T09:00:00Z",
    "sourcePropertyId": "pms-100234",
    "sourceBookingId": "pms-bk-55871",
    "sourceId": "pms-rem-9",
    "actionable": true,
    "checklists": [{ "checklistId": "chk_9RtV" }],
    "jobRequestSettings": {
      "time": { "type": "flexible", "startTime": "2026-10-08T11:00:00Z", "endTime": "2026-10-08T15:00:00Z" },
      "offeredPrice": 90,
      "offeredPriceCurrency": "USD",
      "message": "Turnover clean after the Smith stay."
    }
  }'

Delete a reminder

DELETE /v1/reminders/{reminderId} 204 No Content x-api-key

Deletes the reminder. Returns 204 with no body.

Request

curl -X DELETE https://platform.getproperly.com/v1/reminders/rem_2Pq \
  -H "x-api-key: $PROPERLY_API_KEY"