Update Milestone Reminder. | Virtuous Developer Documentation

curl -X PUT https://api.virtuoussoftware.com/api/Reminder/Saved/Milestone/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "taskType": "<string>",
  "name": "<string>",
  "threshold": "<integer>",
  "isFollowedContactsOnly": "<boolean>",
  "description": "<string>"
}'

{
  "id": "<integer>",
  "name": "<string>",
  "reminderSourceType": "<string>",
  "reminderSourceTypeDisplayName": "<string>",
  "reminders": [
    {
      "id": "<integer>",
      "message": "<string>",
      "targetDate": "<string>",
      "targetResolutionDateUtc": "<dateTime>",
      "contactId": "<integer>",
      "contactViewUrl": "<string>",
      "contactDisplayName": "<string>",
      "contactAvatarUrl": "<string>",
      "reminderType": "<string>",
      "reminderTypeDisplayName": "<string>",
      "taskStatus": "<string>",
      "taskStatusDisplayName": "<string>",
      "completeUrl": "<string>",
      "dismissUrl": "<string>",
      "description": "<string>",
      "hasContact": "<boolean>",
      "isPastDue": "<boolean>",
      "isUnresolved": "<boolean>",
      "canComplete": "<boolean>",
      "completeActionName": "<string>",
      "canCompleteWithNote": "<boolean>",
      "owner": "<string>",
      "ownerAvatarUrl": "<string>"
    },
    {
      "id": "<integer>",
      "message": "<string>",
      "targetDate": "<string>",
      "targetResolutionDateUtc": "<dateTime>",
      "contactId": "<integer>",
      "contactViewUrl": "<string>",
      "contactDisplayName": "<string>",
      "contactAvatarUrl": "<string>",
      "reminderType": "<string>",
      "reminderTypeDisplayName": "<string>",
      "taskStatus": "<string>",
      "taskStatusDisplayName": "<string>",
      "completeUrl": "<string>",
      "dismissUrl": "<string>",
      "description": "<string>",
      "hasContact": "<boolean>",
      "isPastDue": "<boolean>",
      "isUnresolved": "<boolean>",
      "canComplete": "<boolean>",
      "completeActionName": "<string>",
      "canCompleteWithNote": "<boolean>",
      "owner": "<string>",
      "ownerAvatarUrl": "<string>"
    }
  ],
  "message": "<string>",
  "dueDate": "<dateTime>",
  "contactId": "<integer>",
  "contactDisplayName": "<string>",
  "reminderFrequency": "<string>",
  "reminderFrequencyDisplayName": "<string>",
  "milestoneType": "<string>",
  "milestoneTypeDisplayName": "<string>",
  "threshold": "<integer>",
  "description": "<string>"
}

Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only updating a single property, the entire model is still required.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

taskTypestringOptional

namestringOptional

thresholdstringOptional

isFollowedContactsOnlystringOptional

descriptionstringOptional

Response

idstringOptional

namestringOptional

reminderSourceTypestringOptional

reminderSourceTypeDisplayNamestringOptional

reminderslist of objectsOptional

messagestringOptional

dueDatestringOptional

contactIdstringOptional

contactDisplayNamestringOptional

reminderFrequencystringOptional

reminderFrequencyDisplayNamestringOptional

milestoneTypestringOptional

milestoneTypeDisplayNamestringOptional

thresholdstringOptional

descriptionstringOptional

Errors

400

Bad Request Error

404

Not Found Error