1. Home
  2. API v2.0
  3. Notes
  4. Add Note

Add Note

Method: /notes.[format]

Fields:

Name Data Type Description
note String The text you want to save.
context_id Numeric The record type context.
record_id String The id of the record.

Context IDs:
Customer: 2, Prospect: 8, Supplier: 10, Inventory Item: 6, Invoice: 5, Estimate: 4, Purchase Order: 11

Syntax

https://[subdomain].salesbinder.com/api/2.0/notes.json

HTTP Request Type: POST

Example JSON Data to Submit

{
    "note": {
        "note": "This is an API created note for this specific customer account.",
        "context_id": 2,
      	"record_id": "58a36040-a6ac-2257-b587-5c715582ca98"
    }
}

Success

If you have been successful in saving a new contact, the response will return the newly created data object along with a “message” value of “Saved” as seen below.

Example JSON Returned Response

{
    "message": "Saved",
    "note": {
        "note": "This is an API created note for this specific customer account.",
        "context_id": 2,
        "record_id": "58a36040-a6ac-5678-b587-5c716882ca98",
        "account_id": "4d76bc2e-b148-4bd6-95f5-7439b865555",
        "user_id": "55259a96-c945-4eae-b0d8-3fb16882ca98",
        "created_timestamp": 1488745807,
        "event": 0,
        "created": "2017-03-05T20:30:07+00:00",
        "modified": "2017-03-05T20:30:07+00:00",
        "id": "55259a96-c945-4eae-b0d8-5fp16998ca98"
    }
}

Example XML Data to Submit

<?xml version="1.0" encoding="UTF-8" ?>
<note>
  <note>This is an API created note.</note>
  <context_id>2</context_id>
  <record_id>58a36040-a6ac-2257-b587-5c715582ca98</record_id>
</note>
Was this article helpful to you? Yes No