PATCH apioauth/matrixv2/reminderalerts/{reminderalertId}

Update a reminder alert

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reminderalertId

The id of the reminder alert to be updated

unsigned integer

Required

Body Parameters

A PatchVehicleReminderAlertRequest

PatchVehicleReminderAlertRequest
NameDescriptionTypeAdditional 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:06:37.8635044+00:00",
  "EarlyReminderDate": "2025-04-27T16:06:37.8635044+00:00",
  "PeriodicMonths": 1,
  "ReminderType": 0
}

application/xml, text/xml

Sample:
<PatchVehicleReminderAlertRequest 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:06:37.8635044+00:00</ReminderDate>
  <EarlyReminderDate>2025-04-27T16:06:37.8635044+00:00</EarlyReminderDate>
  <PeriodicMonths>1</PeriodicMonths>
  <ReminderType>MOT</ReminderType>
</PatchVehicleReminderAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 on success

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.