Update a Note | Virtuous Developer Documentation

curl -X PUT https://api.virtuoussoftware.com/api/ContactNote/noteId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "<string>",
  "note": "<string>",
  "noteDateTime": "<dateTime>",
  "important": "<boolean>",
  "private": "<boolean>",
  "timeSpent": "<integer>"
}'

{
  "id": "<integer>",
  "contactId": "<integer>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "noteDate": "<string>",
  "type": "<string>",
  "note": "<string>",
  "important": "<boolean>",
  "isPrivate": "<boolean>",
  "createdByAvatarUrl": "<string>",
  "reminder": {
    "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>"
  }
}

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

noteIdstringRequired

Request

This endpoint expects an object.

typestringOptional

notestringOptional

noteDateTimestringOptional

importantstringOptional

privatestringOptional

timeSpentstringOptional

Response

idstringOptional

contactIdstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

noteDatestringOptional

typestringOptional

notestringOptional

importantstringOptional

isPrivatestringOptional

createdByAvatarUrlstringOptional

reminderobjectOptional

Errors

400

Bad Request Error