API reference
All operations
NOTE

Updates an existing note by its ID.

PUT/api/v2/notes/{noteId}

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

noteIdpathinteger · int32required

The ID of the note to update.

Request body

application/jsonrequired

The updated note data.

UpdateNoteRequest
  • noteIdinteger · int32
  • noteTypestring
  • companyIdinteger · int32
  • taskIdinteger · int32nullable
  • recordIdinteger · int32
  • recordTypestring
  • typeIdinteger · int32required
  • noteDatestring · daterequired
  • commentsstringrequired
  • contactsinteger[]
  • notePurposesinteger[]
  • noteResultsinteger[]

Responses

Note updated successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

dataNoteDto
  • noteIdinteger · int32
  • companyIdinteger · int32
  • companyNamestringnullable
  • noteTypestring
  • recordIdinteger · int32
  • recordTypestring
  • relatedTostring
  • ownerstring
  • userIdinteger · int32
  • typeIdinteger · int32
  • noteDatestring · date
  • commentsstring
  • enterBystring
  • lastModifiedBystring
  • lastModifiedstring · date-timenullable
  • enteredstring · date-timenullable
  • deletedboolean
  • contactsinteger[]
  • notePurposesinteger[]
  • noteResultsinteger[]
  • notePurposeDisplaysstring[]
  • noteResultDisplaysstring[]
  • noteContactDisplaysstring[]