Follow

Notes By ContactID Methods '/contacts/{contactid}/notes'

The methods available for Notes are exposed under their respective URIs, which are described below.

If you are using the Notes By ContactID Put method, you will need to designate the TypeID as follows.

Note Types
TypeID
Type
1
Note
2
Email Sent
3
Email Received
4
Mail Merge
5
Workflow Notes
6
Activity
7
Opportunity

 

Notes by ContactID Fetch

Method Type: GET

returns a paged list of notes for a specific contact record

'/contacts/{contactid}/notes?page={page}'

Recommended parameter: {page}*

{#} = page #, non-supplied= page 1

 

Notes By ContactID Put

Method Type: PUT

Creates a Note Record by NoteID.

'/contacts/{contactid}/notes/{noteid}'

 

Recently Added Notes Fetch

Method Type: GET

returns a paged list of Recently Added Notes

'/contacts/notes?page={page}'

Recommended parameter: {page}*

{#} = page #, non-supplied= page 1 

 

Notes By ContactID Fetch

 The URI '/contacts/{contactid}/notes', when coupled with Method Type 'GET',  returns a List of Notes associated with a specific Contact Record.

https://api2.redtailtechnology.com/crm/v1/rest/contacts/{ContactID}/notes

https://api2.redtailtechnology.com/crm/v1/rest/contacts/384843/notes

 

Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/contacts/384843/notes");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

The following is a condensed XML response. The XML response will include up to 50 notes per page and provide a total count of the related note records.

NotesGet.png

 

Notes By NoteID Put

 The URI '/contacts/{contactid}/notes/{noteid}', when coupled with Method Type 'PUT',  Creates a Note by NoteID. To create a new Note Record, the NoteID supplied in the URI should be 0. 

https://api2.redtailtechnology.com/crm/v1/rest/contacts/{ContactID}/notes/{NoteID}

https://api2.redtailtechnology.com/crm/v1/rest/contacts/384843/notes/0

 

Request Header example (C#)

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/contacts/384843/notes/0");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:statementone:sonedemo"));
req.Method = "PUT";
req.ContentType = "text/json";

 

Request Body example (C#)

string reqJSON = "{""CategoryID"":2,""Note"":""Workflow: (New Client Process)<br>Set up a meeting for next week."",""OpportunityID"":0,""RecAddUser"":41974, ""TypeID"":0}";
byte[] reqBody = System.Text.Encoding.ASCII.GetBytes(reqJSON);

//Request Stream
req.GetRequestStream().Write(reqBody, 0, reqBody.Length);

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

Recently Added Notes Fetch

 The URI '/contacts/notes/recent', when coupled with Method Type 'GET',  returns a paged list of recently added notes..

https://api2.redtailtechnology.com/crm/v1/rest/contacts//notes/recent

example: https://api2.redtailtechnology.com/crm/v1/rest/contacts/notes/recent

 

Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/contacts/notes/recent");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk