Creates a Note for a Customer, Quote, or Employee

Prev Next
Post
/api/Note/Create
Security
HTTP
Type bearer

Enter the token obtained from the /token endpoint. Use the format: Bearer

Body parameters
object

Either EntityId or EntityContactInfo must be supplied

EntityTypeId
integer (int32)

Type of entity this note is associated with Quote = 0, Customer = 1, Employee = 2

Valid values[ 0, 1, 2 ]
EntityId
integer (int32)

ID of the entity this note is associated with, EntityTypeId is required if you supply this

EntityContactInfo
string

Contact information of the entity (email, phone, etc.), searches Customer, then Lead, then Employee if EntityTypeId is not supplied

NoteTypeId
integer (int32)

ID of the note type Email = 1, Note = 2 (default), PhoneCall = 3, TextMessage = 4;

Subject
string

Subject: Required if not type is email

Content
string Required

The content of the note

CreateTicket
boolean

For communication notes, indicates if this note should create a ticket, default = false

CommunicationDirectionId
integer (int32)

Direction of communication: InternalNote = 0 (default), Incoming = 1, Outgoing = 2 - (incoming: sent TO company / outgoing: sent FROM company)

Valid values[ 0, 1, 2 ]
SenderContactInfo
string

Sender contact information (email/phone)

RecipientContactInfo
string

Recipient contact information (email/phone)

object

Either EntityId or EntityContactInfo must be supplied

EntityTypeId
integer (int32)

Type of entity this note is associated with Quote = 0, Customer = 1, Employee = 2

Valid values[ 0, 1, 2 ]
EntityId
integer (int32)

ID of the entity this note is associated with, EntityTypeId is required if you supply this

EntityContactInfo
string

Contact information of the entity (email, phone, etc.), searches Customer, then Lead, then Employee if EntityTypeId is not supplied

NoteTypeId
integer (int32)

ID of the note type Email = 1, Note = 2 (default), PhoneCall = 3, TextMessage = 4;

Subject
string

Subject: Required if not type is email

Content
string Required

The content of the note

CreateTicket
boolean

For communication notes, indicates if this note should create a ticket, default = false

CommunicationDirectionId
integer (int32)

Direction of communication: InternalNote = 0 (default), Incoming = 1, Outgoing = 2 - (incoming: sent TO company / outgoing: sent FROM company)

Valid values[ 0, 1, 2 ]
SenderContactInfo
string

Sender contact information (email/phone)

RecipientContactInfo
string

Recipient contact information (email/phone)

object

Either EntityId or EntityContactInfo must be supplied

EntityTypeId
integer (int32)

Type of entity this note is associated with Quote = 0, Customer = 1, Employee = 2

Valid values[ 0, 1, 2 ]
EntityId
integer (int32)

ID of the entity this note is associated with, EntityTypeId is required if you supply this

EntityContactInfo
string

Contact information of the entity (email, phone, etc.), searches Customer, then Lead, then Employee if EntityTypeId is not supplied

NoteTypeId
integer (int32)

ID of the note type Email = 1, Note = 2 (default), PhoneCall = 3, TextMessage = 4;

Subject
string

Subject: Required if not type is email

Content
string Required

The content of the note

CreateTicket
boolean

For communication notes, indicates if this note should create a ticket, default = false

CommunicationDirectionId
integer (int32)

Direction of communication: InternalNote = 0 (default), Incoming = 1, Outgoing = 2 - (incoming: sent TO company / outgoing: sent FROM company)

Valid values[ 0, 1, 2 ]
SenderContactInfo
string

Sender contact information (email/phone)

RecipientContactInfo
string

Recipient contact information (email/phone)

object

Either EntityId or EntityContactInfo must be supplied

EntityTypeId
integer (int32)

Type of entity this note is associated with Quote = 0, Customer = 1, Employee = 2

Valid values[ 0, 1, 2 ]
EntityId
integer (int32)

ID of the entity this note is associated with, EntityTypeId is required if you supply this

EntityContactInfo
string

Contact information of the entity (email, phone, etc.), searches Customer, then Lead, then Employee if EntityTypeId is not supplied

NoteTypeId
integer (int32)

ID of the note type Email = 1, Note = 2 (default), PhoneCall = 3, TextMessage = 4;

Subject
string

Subject: Required if not type is email

Content
string Required

The content of the note

CreateTicket
boolean

For communication notes, indicates if this note should create a ticket, default = false

CommunicationDirectionId
integer (int32)

Direction of communication: InternalNote = 0 (default), Incoming = 1, Outgoing = 2 - (incoming: sent TO company / outgoing: sent FROM company)

Valid values[ 0, 1, 2 ]
SenderContactInfo
string

Sender contact information (email/phone)

RecipientContactInfo
string

Recipient contact information (email/phone)

object

Either EntityId or EntityContactInfo must be supplied

EntityTypeId
integer (int32)

Type of entity this note is associated with Quote = 0, Customer = 1, Employee = 2

Valid values[ 0, 1, 2 ]
EntityId
integer (int32)

ID of the entity this note is associated with, EntityTypeId is required if you supply this

EntityContactInfo
string

Contact information of the entity (email, phone, etc.), searches Customer, then Lead, then Employee if EntityTypeId is not supplied

NoteTypeId
integer (int32)

ID of the note type Email = 1, Note = 2 (default), PhoneCall = 3, TextMessage = 4;

Subject
string

Subject: Required if not type is email

Content
string Required

The content of the note

CreateTicket
boolean

For communication notes, indicates if this note should create a ticket, default = false

CommunicationDirectionId
integer (int32)

Direction of communication: InternalNote = 0 (default), Incoming = 1, Outgoing = 2 - (incoming: sent TO company / outgoing: sent FROM company)

Valid values[ 0, 1, 2 ]
SenderContactInfo
string

Sender contact information (email/phone)

RecipientContactInfo
string

Recipient contact information (email/phone)

object

Either EntityId or EntityContactInfo must be supplied

EntityTypeId
integer (int32)

Type of entity this note is associated with Quote = 0, Customer = 1, Employee = 2

Valid values[ 0, 1, 2 ]
EntityId
integer (int32)

ID of the entity this note is associated with, EntityTypeId is required if you supply this

EntityContactInfo
string

Contact information of the entity (email, phone, etc.), searches Customer, then Lead, then Employee if EntityTypeId is not supplied

NoteTypeId
integer (int32)

ID of the note type Email = 1, Note = 2 (default), PhoneCall = 3, TextMessage = 4;

Subject
string

Subject: Required if not type is email

Content
string Required

The content of the note

CreateTicket
boolean

For communication notes, indicates if this note should create a ticket, default = false

CommunicationDirectionId
integer (int32)

Direction of communication: InternalNote = 0 (default), Incoming = 1, Outgoing = 2 - (incoming: sent TO company / outgoing: sent FROM company)

Valid values[ 0, 1, 2 ]
SenderContactInfo
string

Sender contact information (email/phone)

RecipientContactInfo
string

Recipient contact information (email/phone)

Responses
200

Successful Response

object
IsSuccess
boolean
Message
string
Result
integer (int32)
InnerException
string
StatusCode
integer (int32)
object
IsSuccess
boolean
Message
string
Result
integer (int32)
InnerException
string
StatusCode
integer (int32)
object
IsSuccess
boolean
Message
string
Result
integer (int32)
InnerException
string
StatusCode
integer (int32)
object
IsSuccess
boolean
Message
string
Result
integer (int32)
InnerException
string
StatusCode
integer (int32)
object
IsSuccess
boolean
Message
string
Result
integer (int32)
InnerException
string
StatusCode
integer (int32)