Create a journal entry (a CRM note) on a lead or a customer. Journal entries created through the API show up in the software the same way as entries typed in by hand.
| Method | URL | Package |
|---|---|---|
| POST | https://rental.software/api6/journals | WP/API and Sales CRM |
Request
All the below parameters are optional unless marked required. Either a lead or a customer is required.
POST /api6/journals/?apiKey=YOUR_API_KEY {
desc: Customer called to ask about a rain date
lead: 520247
crmstatus: open
}| Parameter | Required | Description |
|---|---|---|
| desc | Yes | The journal entry text |
| lead | One of lead or cust | Lead ID linked to the journal |
| cust | One of lead or cust | Contact (customer) ID linked to the journal |
| org | No | Organization ID linked to the journal |
| crmstatus | No | Options: awaiting, closed, open |
| assignedtoid | No | Worker ID of the worker the journal is assigned to |
| read | No | Mark journal as read. Options: 0, 1 |
| thisLeadOnly | No | Send 1 to link the journal to only the specified lead ID. Without it, an entry sent with a lead is saved on that lead's customer, so it shows on all of the customer's leads |
Example
curl -X POST "https://rental.software/api6/journals" \ -d "apiKey=YOUR_API_KEY" \ -d "desc=Customer called to ask about a rain date" \ -d "lead=520247" \ -d "thisLeadOnly=1"
Response
A successful call returns HTTP 200 with the ID of the new journal entry:
{
"id": 9914527,
"request_time": 1760000000
}Errors
| Status | Message | What to do |
|---|---|---|
| 400 | Missing required inputs. | Send desc plus either lead or cust. An org on its own is not enough |
| 405 | Only accepts POST requests | Use POST |
See API - Errors and Rate Limits for errors that apply to every call.
Starting with the October 2026 release: journal entries can also be read and updated through the API. See API - Journal - Retrieve and Update.