POST apioauth/matrixv2/services/{serviceId}/reminderalerts

Create a reminder alert for a service

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceId	The service id the alert is being created for	unsigned integer	Required

Body Parameters

A CreateVehicleReminderAlert

CreateVehicleReminderAlertRequest

Name	Description	Type	Additional information
PushNotificationEnabled	If you want mobile push notifications sent on alert	boolean	None.
InboxMessageEnabled	If you want an inbox message sent on alert	boolean	None.
EmailEnabled	If you want emails sent on alert	boolean	None.
ReminderDate	The date when the reminder alert will be triggered	date	None.
EarlyReminderDate	The date when an early reminder will be triggered	date	None.
PeriodicMonths	If greater than 0 the reminder will be reset this many months after triggering	integer	None.
ReminderType	The type of the reminder	ReminderType	None.

Request Formats

application/json, text/json

Sample:

{
  "PushNotificationEnabled": true,
  "InboxMessageEnabled": true,
  "EmailEnabled": true,
  "ReminderDate": "2025-04-27T16:33:48.0515441+00:00",
  "EarlyReminderDate": "2025-04-27T16:33:48.0515441+00:00",
  "PeriodicMonths": 6,
  "ReminderType": 0
}

application/xml, text/xml

Sample:

<CreateVehicleReminderAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PushNotificationEnabled>true</PushNotificationEnabled>
  <InboxMessageEnabled>true</InboxMessageEnabled>
  <EmailEnabled>true</EmailEnabled>
  <ReminderDate>2025-04-27T16:33:48.0515441+00:00</ReminderDate>
  <EarlyReminderDate>2025-04-27T16:33:48.0515441+00:00</EarlyReminderDate>
  <PeriodicMonths>6</PeriodicMonths>
  <ReminderType>MOT</ReminderType>
</CreateVehicleReminderAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A CreateVehicleReminderAlertResponse

CreateVehicleReminderAlertResponse

Name	Description	Type	Additional information
ReminderAlertId	The id of the reminder alert	unsigned integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ReminderAlertId": 1
}

application/xml, text/xml

Sample:

<CreateVehicleReminderAlertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReminderAlertId>1</ReminderAlertId>
</CreateVehicleReminderAlertResponse>