Create a task linked to a customer, a lead or an organization. Tasks created through the API show up in the software the same way as tasks created by hand.
| Method | URL | Package |
|---|---|---|
| POST | https://rental.software/api6/tasks | WP/API and Sales CRM |
Request
The first five parameters below are required. The rest are optional. This is not a complete list.
POST /api6/tasks/?apiKey=YOUR_API_KEY {
task_status: New
task_desc: Call to confirm the delivery window
task_linkto: Jordan Rivera
task_linkid: 533268
task_linktype: Cust
}| Parameter | Required | Description |
|---|---|---|
| task_status | Yes | Status. Options: New, In Progress, Completed, Rejected |
| task_desc | Yes | Task description |
| task_linkto | Yes | Name of the customer, lead, or organization the task is linked to |
| task_linkid | Yes | Contact ID, or lead ID, or organization ID |
| task_linktype | Yes | What type of ID task_linkid is. Options: Cust, Lead, Org |
| task_assignedid | No | Worker ID of the worker the task is assigned to. The worker's name is filled in for you |
| task_assignedto | No | Name of who the task is assigned to. Only needed when you do not send task_assignedid |
| task_read | No | Mark task as read. Options: 0, 1 |
| task_reminddate | No | Reminder date, in the date format of your account (for example 7/25/2026) |
| task_remindtime | No | Reminder time, for example 2:00pm. Defaults to 12:00pm |
| task_reminder | No | Reminder date and time as a Unix timestamp. Use this instead of task_reminddate and task_remindtime if you prefer timestamps |
| task_recurring | No | Task recurring option. Options: Never, Weekly, Monthly, Yearly. A recurring task needs a reminder |
| task_badge | No | Show Badge. Options: 0, 1 |
| task_email | No | Send Email. Options: 0, 1 |
| task_flag | No | Show Flag. Options: 0, 1 |
| task_calendar | No | Show on Calendar. Options: 0, 1 |
Example
curl -X POST "https://rental.software/api6/tasks" \ -d "apiKey=YOUR_API_KEY" \ -d "task_status=New" \ -d "task_desc=Call to confirm the delivery window" \ -d "task_linkto=Jordan Rivera" \ -d "task_linkid=533268" \ -d "task_linktype=Cust" \ -d "task_reminddate=7/25/2026" \ -d "task_remindtime=9:00am"
Response
A successful call returns HTTP 200 with the ID of the new task:
{
"id": 77123,
"request_time": 1760000000
}Errors
| Status | Message | What to do |
|---|---|---|
| 400 | Missing required inputs. | Send all five required parameters: task_status, task_desc, task_linkto, task_linkid and task_linktype |
| 405 | Only accepts POST requests | Use POST. Tasks cannot be read through the API |
See API - Errors and Rate Limits for errors that apply to every call.