Objects

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.

post/projects

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/projects
  • Auth: API key in header x-api-key

Request body

titlestring required

Project title

pipelineIdstring required

Project pipeline ID (ppl_ prefix)

stageIdstring nullable

Project pipeline stage ID (pps_ prefix). If omitted, the first OPEN stage in the pipeline is used.

clientIdstring nullable

Contact or company ID (clt_ prefix)

projectLeadIdstring nullable

Project lead user ID (usr_ prefix). Defaults to the API key user when omitted.

salesPersonIdstring nullable

Sales person user ID (usr_ prefix)

status'ACTIVE' | 'COMPLETED' | 'CANCELLED'

Project status

type'flat_rate' | 'retainer'

Project type

startDatestring date-time

Project start date

endDatestring date-time

Project end date

budgetedHoursnumber

Budgeted hours

descriptionstring

Project description

isInclusiveTaxboolean

Whether project line item prices include tax

assigneesstring[]

Assignee user IDs (usr_ prefix)

tagsstring[]

Tag IDs (tag_ prefix)

Response

OK

idstring nullable required

Project ID (prj_ prefix)

numberstring required

Auto-generated project number

titlestring required

Project title

status'ACTIVE' | 'COMPLETED' | 'CANCELLED' nullable

Project status

type'flat_rate' | 'retainer' nullable

Project type

startDatestring date-time nullable

Project start date

endDatestring date-time nullable

Project end date

pipelineIdstring nullable

Project pipeline ID (ppl_ prefix)

pipelineNamestring nullable

Pipeline name

stageIdstring nullable

Project pipeline stage ID (pps_ prefix)

stageNamestring nullable

Stage name

projectLeadIdstring nullable

Project lead user ID (usr_ prefix)

projectLeadNamestring nullable

Project lead name

clientIdstring nullable

Client ID (clt_ prefix)

clientNamestring nullable

Client name

descriptionstring nullable

Project description

budgetedHoursnumber nullable

Budgeted hours

createdAtstring date-time nullable

When the project was created

updatedAtstring date-time nullable

When the project was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.