Create a new note

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Notice to Ferret API (v1) users

We’re excited to announce the beta release of Ferret API v2, offering a more consistent and expanded approach, with access to a wider range of objects.

New clients are encouraged to start with Ferret API v2 and/or Octopus API to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared a detailed migration guide.

Body Params

Command to create a new note

string | null

Parent company key


*required when LegacyOpportunityKey and LegacyContactKey are empty

string | null

Parent contact key


*required when LegacyCompanyKey and LegacyOpportunityKey are empty

string | null

Parent opportunity key


*required when LegacyCompanyKey and LegacyContactKey are empty

int32
enum

0 = Manual, 1 = Mailouts, 2 = OutgoingCalls, 3 = TimedNote, 4 = TransferLog, 5 = CompletedTask, 6 = ScheduledTask, 7 = Email, 8 = Opportunity, 9 = History, 10 = ReassignTask, 11 = Other, 12 = CustomerService, 13 = Accounting, 14 = IncomingCalls

string
required
length ≥ 1

Note's body text

int32
enum

0 = Normal, 1 = Important, 2 = Critical

Allowed:
string | null

Note's category

date-time
required

Note's date

string
required
length ≥ 1

Legacy creator key

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json