Create Manual Reminder | Virtuous Developer Documentation

curl -X POST https://api.virtuoussoftware.com/api/Reminder \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "taskType": "<string>",
  "message": "<string>",
  "dueDate": "<dateTime>",
  "contactId": "<integer>",
  "ownerEmail": "<string>",
  "description": "<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>"
}

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

taskTypestringOptional

messagestringOptional

dueDatestringOptional

contactIdstringOptional

ownerEmailstringOptional

descriptionstringOptional

Response

idstringOptional

messagestringOptional

targetDatestringOptional

targetResolutionDateUtcstringOptional

contactIdstringOptional

contactViewUrlstringOptional

contactDisplayNamestringOptional

contactAvatarUrlstringOptional

reminderTypestringOptional

reminderTypeDisplayNamestringOptional

taskStatusstringOptional

taskStatusDisplayNamestringOptional

completeUrlstringOptional

dismissUrlstringOptional

descriptionstringOptional

hasContactstringOptional

isPastDuestringOptional

isUnresolvedstringOptional

canCompletestringOptional

completeActionNamestringOptional

canCompleteWithNotestringOptional

ownerstringOptional

ownerAvatarUrlstringOptional

Errors

400

Bad Request Error