API Documentation

NotesAdd Note

Method: /notes.[format]

Contexts:

Context IDs:

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

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.

Syntax:

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

HTTP Request Type: POST

Example JSON Data to Submit

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

Example XML Data to Submit

1<?xml version="1.0" encoding="UTF-8" ?>
2<note>
3  <note>This is an API created note.</note>
4  <context_id>2</context_id>
5  <record_id>58a36040-a6ac-2257-b587-5c715582ca98</record_id>
6</note>

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

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

Updated on March 5th, 2017