Notes
Create note
Create a new note and assign it with an existing partner, leads, deal, customer or payout.
The content prop can be formatted using simple HTML formatting.
POST
/
v3
/
notes
Create note
curl --request POST \
--url https://api.example.com/v3/notes \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"content": "<string>",
"partnerId": 123,
"dealId": 123,
"leadId": 123,
"payoutId": 123,
"customerId": 123,
"isSynced": true,
"taskName": "<string>",
"taskDueDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.example.com/v3/notes"
payload = {
"content": "<string>",
"partnerId": 123,
"dealId": 123,
"leadId": 123,
"payoutId": 123,
"customerId": 123,
"isSynced": True,
"taskName": "<string>",
"taskDueDate": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
content: '<string>',
partnerId: 123,
dealId: 123,
leadId: 123,
payoutId: 123,
customerId: 123,
isSynced: true,
taskName: '<string>',
taskDueDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.example.com/v3/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v3/notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'partnerId' => 123,
'dealId' => 123,
'leadId' => 123,
'payoutId' => 123,
'customerId' => 123,
'isSynced' => true,
'taskName' => '<string>',
'taskDueDate' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v3/notes"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"partnerId\": 123,\n \"dealId\": 123,\n \"leadId\": 123,\n \"payoutId\": 123,\n \"customerId\": 123,\n \"isSynced\": true,\n \"taskName\": \"<string>\",\n \"taskDueDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v3/notes")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"content\": \"<string>\",\n \"partnerId\": 123,\n \"dealId\": 123,\n \"leadId\": 123,\n \"payoutId\": 123,\n \"customerId\": 123,\n \"isSynced\": true,\n \"taskName\": \"<string>\",\n \"taskDueDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"content\": \"<string>\",\n \"partnerId\": 123,\n \"dealId\": 123,\n \"leadId\": 123,\n \"payoutId\": 123,\n \"customerId\": 123,\n \"isSynced\": true,\n \"taskName\": \"<string>\",\n \"taskDueDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"content": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdByUser": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"createdByPartnerId": 123,
"createdByPartnerName": "<string>",
"partnerId": 123,
"customerId": 123,
"dealId": 123,
"leadId": 123,
"payoutId": 123,
"visibility": "Unknown"
}Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Minimum string length:
1Available options:
Unknown, Private, Public Response
Note created
Show child attributes
Show child attributes
Available options:
Unknown, Private, Public Create note
curl --request POST \
--url https://api.example.com/v3/notes \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"content": "<string>",
"partnerId": 123,
"dealId": 123,
"leadId": 123,
"payoutId": 123,
"customerId": 123,
"isSynced": true,
"taskName": "<string>",
"taskDueDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.example.com/v3/notes"
payload = {
"content": "<string>",
"partnerId": 123,
"dealId": 123,
"leadId": 123,
"payoutId": 123,
"customerId": 123,
"isSynced": True,
"taskName": "<string>",
"taskDueDate": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
content: '<string>',
partnerId: 123,
dealId: 123,
leadId: 123,
payoutId: 123,
customerId: 123,
isSynced: true,
taskName: '<string>',
taskDueDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.example.com/v3/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v3/notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'partnerId' => 123,
'dealId' => 123,
'leadId' => 123,
'payoutId' => 123,
'customerId' => 123,
'isSynced' => true,
'taskName' => '<string>',
'taskDueDate' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v3/notes"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"partnerId\": 123,\n \"dealId\": 123,\n \"leadId\": 123,\n \"payoutId\": 123,\n \"customerId\": 123,\n \"isSynced\": true,\n \"taskName\": \"<string>\",\n \"taskDueDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v3/notes")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"content\": \"<string>\",\n \"partnerId\": 123,\n \"dealId\": 123,\n \"leadId\": 123,\n \"payoutId\": 123,\n \"customerId\": 123,\n \"isSynced\": true,\n \"taskName\": \"<string>\",\n \"taskDueDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"content\": \"<string>\",\n \"partnerId\": 123,\n \"dealId\": 123,\n \"leadId\": 123,\n \"payoutId\": 123,\n \"customerId\": 123,\n \"isSynced\": true,\n \"taskName\": \"<string>\",\n \"taskDueDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"content": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"createdByUser": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"createdByPartnerId": 123,
"createdByPartnerName": "<string>",
"partnerId": 123,
"customerId": 123,
"dealId": 123,
"leadId": 123,
"payoutId": 123,
"visibility": "Unknown"
}