This API adds notes to existing contacts in your CRM system. Notes can be configured with visibility and editability settings to control who can see and modify them. Only the member who owns the contact can add notes to it.

💡 Pro Tip

Use this API to build comprehensive contact history and activity tracking. Set note_visibility to 1 to make notes visible to other team members, and note_editable to 1 to allow others to edit the notes.

Request Endpoint: https://app.zyntrohq.com/apis/public/addNotestoContact.php

Request Method: POST

Request Payload:

{
  "api_key": "your_zyntro_api_key",
  "org_id": "your_organization_id",
  "member_id": "your_member_id",
  "contact_id": "contact_id_to_add_note_to",
  "note": "This is a test note about the contact",
  "note_visibility": 1,
  "note_editable": 0
}

Response (JSON):

{
  "status": "success",
  "data": {
    "note_id": "note_unique_id",
    "note_content": "This is a test note about the contact",
    "note_visibility": 1,
    "note_editable": 0
  }
}

Response Fields:

  • status: Indicates success or error status
  • data: Object containing note details
  • note_id: Unique identifier for the created note
  • note_content: The content of the note
  • note_visibility: Visibility setting (0 = private, 1 = visible to others)
  • note_editable: Editability setting (0 = not editable, 1 = editable by others)

Required Fields:

  • api_key: Zyntro API authentication key
  • org_id: Organization identifier (UUID format)
  • member_id: Member identifier (UUID format) - must be the owner of the contact
  • contact_id: Contact identifier (UUID format) - the contact to add the note to
  • note: The note content (string)

Optional Fields:

  • note_visibility: Visibility setting (integer, 0 or 1, default: 0)
    • 0 = Private note (only visible to the note creator)
    • 1 = Visible to other team members
  • note_editable: Editability setting (integer, 0 or 1, default: 0)
    • 0 = Not editable by others
    • 1 = Editable by other team members

Notes:

  • This is a public API and requires an API Key. You can get your API Key from inside your Zyntro Account under Me > API Keys
  • Ensure that the api_key, org_id, member_id, and contact_id are valid and correspond to your Zyntro account credentials
  • The org_id should correspond to an existing organization within your account
  • The member_id should correspond to an existing member within the organization
  • The contact_id should correspond to an existing contact within the organization
  • Organization must be active for API calls to be processed successfully
  • Only the member who owns the contact can add notes to it
  • Contact must belong to the same organization as the member
  • Note content is automatically escaped to prevent SQL injection
  • Note visibility and editability settings control team collaboration features
  • Use this API to build contact activity logs and team collaboration features