Prospect Note

Notes related to prospects

createdAt
string or null <date-time>

The date and time the prospect note was created.

message
string or null <= 65535 characters

The text content of this prospect note.

noteType
string or null <= 255 characters

The context of this prospect note, one of {note,call,coffee,beer,meeting}.

opportunityAssociationRule
string or null <= 255 characters

The rule used to associate the account note with an opportunity, one of {recent_created,recent_updated}.

pinned
boolean or null

A boolean value indicating whether this prospect note is pinned.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "noteType": "string",
  • "opportunityAssociationRule": "string",
  • "pinned": true
}

Prospect Note Relationships

object

The creator of the prospect note. Relationship creator cannot be used as a filter.

object

The opportunity this prospect note is related to. Relationship opportunity cannot be used as a filter.

object

The prospect this prospect note is related to. You can use only the attribute id to filter prospectNotes by prospect (e.g. filter[prospect][id]=X).

{
  • "creator": {},
  • "opportunity": {},
  • "prospect": {}
}

⌵ Prospect Note Actions

Get a Collection of Prospect Notes

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/prospectNotes
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Prospect Note
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/prospectNotes
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Prospect Note by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/prospectNotes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Prospect Note by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/prospectNotes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Prospect Note
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/prospectNotes/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}