This documentation relates to CiviCRM version 3.2. It's not maintained anymore.
Current version of documentation.

Note APIs

Skip to end of metadata
Go to start of metadata

This page refers to outdated version of CiviCRM. Check current version of documentation.


Documentation Search


CiviCRM 3.2 Documentation

Support and Participation

Developer Resources


CiviCRM book!

Make sure to check out Understanding CiviCRM as well! You can also support this project by ordering a hard copy.

Note APIs

civicrm_note_create( &$params )

Availability: v1.8

Creates a note for a contact

Parameters:

  • 'params' (array) Associative array of property name/value pairs
  • for updating note record pass note id in array like $params['id']

Returns:

  • On success, returns array containing note_id
  • On failure, returns array containing error_message
    CreateNote
    Result

civicrm_note_get( &$params )

Availability: v1.8

get the note(s) for an entity

Parameters:

  • 'params' (array) Associative array of property name/value pairs

Returns:

  • On success, returns array containing notes for the entity. Hard-coded to show only the note body text - no additional fields. 
  • On failure, returns array containing error_message
Get Note
Result

civicrm_note_delete( &$params )

Availability: v1.8

Deletes the specified Note.

Parameters:

  • 'params' (array) A valid (name/value pair) .

Returns:

  • true if success, else false
  • An error if 'contact' is invalid, permissions are insufficient, etc.
    Delete Note
    Result
Labels
  • None

Creative Commons License
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.