curl --request POST \
--url https://api.heffl.com/api/v2/projects \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"clientId": "<string>",
"projectLeadId": "<string>",
"salesPersonId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"budgetedHours": 123,
"description": "<string>",
"isInclusiveTax": true,
"assignees": [
"<string>"
],
"tags": [
"<string>"
]
}
'import requests
url = "https://api.heffl.com/api/v2/projects"
payload = {
"title": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"clientId": "<string>",
"projectLeadId": "<string>",
"salesPersonId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"budgetedHours": 123,
"description": "<string>",
"isInclusiveTax": True,
"assignees": ["<string>"],
"tags": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
pipelineId: '<string>',
stageId: '<string>',
clientId: '<string>',
projectLeadId: '<string>',
salesPersonId: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
budgetedHours: 123,
description: '<string>',
isInclusiveTax: true,
assignees: ['<string>'],
tags: ['<string>']
})
};
fetch('https://api.heffl.com/api/v2/projects', 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.heffl.com/api/v2/projects",
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([
'title' => '<string>',
'pipelineId' => '<string>',
'stageId' => '<string>',
'clientId' => '<string>',
'projectLeadId' => '<string>',
'salesPersonId' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'budgetedHours' => 123,
'description' => '<string>',
'isInclusiveTax' => true,
'assignees' => [
'<string>'
],
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.heffl.com/api/v2/projects"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"projectLeadId\": \"<string>\",\n \"salesPersonId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"budgetedHours\": 123,\n \"description\": \"<string>\",\n \"isInclusiveTax\": true,\n \"assignees\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/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.heffl.com/api/v2/projects")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"projectLeadId\": \"<string>\",\n \"salesPersonId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"budgetedHours\": 123,\n \"description\": \"<string>\",\n \"isInclusiveTax\": true,\n \"assignees\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"projectLeadId\": \"<string>\",\n \"salesPersonId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"budgetedHours\": 123,\n \"description\": \"<string>\",\n \"isInclusiveTax\": true,\n \"assignees\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"number": "<string>",
"title": "<string>",
"status": "ACTIVE",
"type": "flat_rate",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"pipelineId": "<string>",
"pipelineName": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"projectLeadId": "<string>",
"projectLeadName": "<string>",
"clientId": "<string>",
"clientName": "<string>",
"description": "<string>",
"budgetedHours": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Create project
Creates a new project. Required: title, pipelineId (ppl_). Optional stageId (pps_) — if omitted, the first OPEN stage in the pipeline is used. Call GET /project-pipelines to discover IDs. projectLeadId defaults to the API key user. Custom field values use cf_* keys — see the Custom fields guide.
curl --request POST \
--url https://api.heffl.com/api/v2/projects \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"clientId": "<string>",
"projectLeadId": "<string>",
"salesPersonId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"budgetedHours": 123,
"description": "<string>",
"isInclusiveTax": true,
"assignees": [
"<string>"
],
"tags": [
"<string>"
]
}
'import requests
url = "https://api.heffl.com/api/v2/projects"
payload = {
"title": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"clientId": "<string>",
"projectLeadId": "<string>",
"salesPersonId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"budgetedHours": 123,
"description": "<string>",
"isInclusiveTax": True,
"assignees": ["<string>"],
"tags": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
pipelineId: '<string>',
stageId: '<string>',
clientId: '<string>',
projectLeadId: '<string>',
salesPersonId: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
budgetedHours: 123,
description: '<string>',
isInclusiveTax: true,
assignees: ['<string>'],
tags: ['<string>']
})
};
fetch('https://api.heffl.com/api/v2/projects', 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.heffl.com/api/v2/projects",
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([
'title' => '<string>',
'pipelineId' => '<string>',
'stageId' => '<string>',
'clientId' => '<string>',
'projectLeadId' => '<string>',
'salesPersonId' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'budgetedHours' => 123,
'description' => '<string>',
'isInclusiveTax' => true,
'assignees' => [
'<string>'
],
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.heffl.com/api/v2/projects"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"projectLeadId\": \"<string>\",\n \"salesPersonId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"budgetedHours\": 123,\n \"description\": \"<string>\",\n \"isInclusiveTax\": true,\n \"assignees\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/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.heffl.com/api/v2/projects")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"projectLeadId\": \"<string>\",\n \"salesPersonId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"budgetedHours\": 123,\n \"description\": \"<string>\",\n \"isInclusiveTax\": true,\n \"assignees\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"projectLeadId\": \"<string>\",\n \"salesPersonId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"budgetedHours\": 123,\n \"description\": \"<string>\",\n \"isInclusiveTax\": true,\n \"assignees\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"number": "<string>",
"title": "<string>",
"status": "ACTIVE",
"type": "flat_rate",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"pipelineId": "<string>",
"pipelineName": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"projectLeadId": "<string>",
"projectLeadName": "<string>",
"clientId": "<string>",
"clientName": "<string>",
"description": "<string>",
"budgetedHours": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Body
Project title
Project pipeline ID (ppl_ prefix)
Project pipeline stage ID (pps_ prefix). If omitted, the first OPEN stage in the pipeline is used.
Contact or company ID (clt_ prefix)
Project lead user ID (usr_ prefix). Defaults to the API key user when omitted.
Sales person user ID (usr_ prefix)
Project status
ACTIVE, COMPLETED, CANCELLED Project type
flat_rate, retainer Project start date
Project end date
Budgeted hours
Project description
Whether project line item prices include tax
Assignee user IDs (usr_ prefix)
Tag IDs (tag_ prefix)
Custom field values using cf_* keys. Only documented fields and cf_* keys are accepted.
Response
OK
Project ID (prj_ prefix)
Auto-generated project number
Project title
Project status
ACTIVE, COMPLETED, CANCELLED Project type
flat_rate, retainer Project start date
Project end date
Project pipeline ID (ppl_ prefix)
Pipeline name
Project pipeline stage ID (pps_ prefix)
Stage name
Project lead user ID (usr_ prefix)
Project lead name
Client ID (clt_ prefix)
Client name
Project description
Budgeted hours
When the project was created
When the project was last updated
Custom field values as top-level cf_* keys (for example cf_priority). There is no customFields wrapper.