Create a Note or Call Log

POST https://api.chartmogul.com/v1/customer_notes

Creates a note object with a note or call type under a specified customer.

curl -X POST "https://api.chartmogul.com/v1/customer_notes" \
     -u YOUR_API_KEY: \
     -H "Content-Type: application/json" \
     -d '{
            "customer_uuid":"cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
            "type": "note",
            "author_email": "[email protected]",
            "text": "Trial extended by two weeks.<br>Key contact on leave until May.",
            "created_at":"2023-11-01T00:00:00Z"
        }'
ChartMogul::Note.create!(
  customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  type: "note",
  author_email: "[email protected]",
  text: "Trial extended by two weeks.<br>Key contact on leave until May.",
  created_at: Time.utc(2023, 11, 01),
)
ChartMogul.CustomerNote.create(config, {
  customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  type: "note",
  author_email: "[email protected]",
  text: "Trial extended by two weeks.<br>Key contact on leave until May.",
  created_at: "2023-11-01T00:00:00Z",
});
ChartMogul\CustomerNote::create([
  "customer_uuid" => "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  "type" => "note",
  "author_email" => "[email protected]",
  "text" => "Trial extended by two weeks.<br>Key contact on leave until May.",
  "created_at" => "2023-11-01T00:00:00Z"
]);
api.CreateNote(&cm.NewNote{
  CustomerUUID: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  Type:         "note",
  Text:         "Trial extended by two weeks.<br>Key contact on leave until May.",
  Author:       "[email protected]",
  CreatedAt:    "2023-11-01T00:00:00Z"
})
chartmogul.CustomerNote.create(
  config,
  data={
    "customer_uuid": "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
    "type": "note",
    "author_email": "[email protected]",
    "text": "Trial extended by two weeks.<br>Key contact on leave until May.",
    "created_at": "2023-11-01T00:00:00Z",
  },
)
{
  "uuid": "note_39351ba6-dea0-11ee-ac96-37b2b3de29af",
  "customer_uuid": "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  "type": "note",
  "text": "Trial extended by two weeks.<br>Key contact on leave until May.",
  "call_duration": 0,
  "author": "Adam ([email protected])",
  "created_at": "2023-11-01T00:00:00.000Z",
  "updated_at": "2023-12-21T10:53:50.082Z"
}
#<ChartMogul::Note:0x00007fb757b74038 
  @customer_uuid="cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0", 
  @type="note", 
  @text="Trial extended by two weeks.<br>Key contact on leave until May.", 
  @created_at="2023-11-01T00:00:00.000Z", 
  @author="Adam ([email protected])",
  @call_duration=0, 
  @updated_at="2023-12-21T10:53:50.082Z", 
  @uuid="note_39351ba6-dea0-11ee-ac96-37b2b3de29af"
>
{
  uuid: "note_39351ba6-dea0-11ee-ac96-37b2b3de29af",
  customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  type: "note",
  text: "Trial extended by two weeks.<br>Key contact on leave until May.",
  call_duration: 0,
  author: "Adam ([email protected])",
  created_at: "2023-11-01T00:00:00.000Z",
  updated_at: "2023-12-21T10:53:50.082Z"
}
class ChartMogul\CustomerNote (8) {
  protected $uuid => string(41) "note_39351ba6-dea0-11ee-ac96-37b2b3de29af"
  protected $customer_uuid => string(40) "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0"
  protected $type => string(4) "note"
  protected $text => string(98) "Trial extended by two weeks.<br>Key contact on leave until May."
  protected $call_duration => int(1)
  protected $author => string(23) "Adam ([email protected])"
  protected $created_at => string(24) "2023-11-01T00:00:00.000Z"
  protected $updated_at => string(24) "2023-12-21T10:53:50.082Z"
}
(*chartmogul.Note)(0x17000568000)({
  UUID: (string) (len=41) "note_39351ba6-dea0-11ee-ac96-37b2b3de29af",
  CustomerUUID: (string) (len=40) "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  Type: (string) (len=40) "note",
  Text: (string) (len=98) "Trial extended by two weeks.<br>Key contact on leave until May.",
  CallDuration (uint32) 0
  Author:  (string) (len=23) "Adam ([email protected])",
  CreatedAt: (string) (len=24) "2023-11-01T00:00:00.000Z",
  UpdatedAt: (string) (len=24) "2023-12-21T10:53:50.082Z"
})
<Note{
  uuid: "note_39351ba6-dea0-11ee-ac96-37b2b3de29af",
  customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  type: "note",
  text: "Trial extended by two weeks.<br>Key contact on leave until May.",
  call_duration: 0,
  author: "Adam ([email protected])",
  created_at: "2023-11-01T00:00:00.000Z",
  updated_at: "2023-12-21T10:53:50.082Z"
}>

Body parameters

customer_uuid string required
The ChartMogul UUID of the customer for the note or call log you’re creating.
type string required
The type of customer note. Can be either note or call.
author_email string optional
The email of the author of the note or call log. The email has to match a team member who belongs to the account.
text string optional
Contents of the note or call log as plain text or HTML.
call_duration integer optional
Relevant for type call. Duration of the call in seconds. Defaults to 60 seconds if not provided.
created_at string optional
The date and time when this note or call was made. Defaults to now if not provided. Must be an ISO 8601-formatted time in the past. The timezone defaults to UTC unless otherwise specified.