Skip to content

addprojecttask.md

Latest commit

 

History

History
97 lines (75 loc) · 2.35 KB

addprojecttask.md

File metadata and controls

97 lines (75 loc) · 2.35 KB

+++ title = "AddProjectTask" toc = true +++

Adds a Task to a project

Request Parameters

Parameter Type Description Required
action string "AddProjectTask" Required
projectid int The ID of the project the task is for. Required
duedate string The due date for the task. Format: YYYY-mm-dd Required
adminid int The admin ID to associate the task with. Optional
task string The task title. Optional
notes string The notes for the task. Optional
completed bool Whether the task has been completed. Optional
billed bool Whether the task has been billed. Optional

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
message string 'Task has been added'

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddProjectTask',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'projectid' => '1',
            'duedate' => '2016-01-01',
            'task' => 'This is a sample message',
            'adminid' => '2',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

$command = 'AddProjectTask';
$postData = array(
    'projectid' => '1',
    'duedate' => '2016-01-01',
    'task' => 'This is a sample message',
    'adminid' => '2',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response JSON

{
    "result": "success",
    "message": "Task has been added"
}

Error Responses

Possible error condition responses include:

  • Project ID not Set
  • Project ID Not Found
  • Admin ID Not Found
  • A task description must be specified

Version History

Version Changelog
1.0 Initial Version