Skip to content

CreateProject

namestringrequired

The name of the Project, typically describing the work engagement or scope for the Client.

start_datestring, (date)required

The scheduled start date for the Project’s resource plan.

end_datestring or null, (date)

The scheduled end date for the Project’s resource plan.

client_idstring, (uuid)required

Id of the Client associated with this Project.

target_budgetobject(Money)required

The target budget for the Project, representing the expected revenue from the Client.

target_marginnumber or null, (double)

Target margin for the Project. Defaults to Organization's target margin.

tagsArray of strings

A list of tags assigned to the Project for filtering, categorization, or reporting.

project_modelstring(ProjectModel)

Project model. Default is client.

Enum:"client""internal"
currency_codestring or null

Currency code for the Project. Defaults to Organization's currency code.

statusstring or null(ProjectStatus)

Status for the Project. Default is pre_sale.

Enum:"pre_sale""awaiting_start""completed""in_progress""on_hold"
stage_idstring or null, (uuid)

The CRM Pipeline Stage id this Project is linked to.

project_owner_idstring or null, (uuid)

Id of the Person who owns this Project.

sales_owner_idstring or null, (uuid)

Id of the Person who is responsible for the sale of this Project.

external_idsArray of strings or null

Optional list of custom external IDs to associate with the Project at creation time. Each ID must not start with a reserved 'px_' provider prefix and must be unique across all Projects in the organization. Forward slashes (/) are not supported.

{ "name": "string", "start_date": "2019-08-24", "end_date": "2019-08-24", "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643", "target_budget": { "currency_code": "string", "amount": 0 }, "target_margin": 0.1, "tags": [ "string" ], "project_model": "client", "currency_code": "string", "status": "pre_sale", "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670", "project_owner_id": "b9aa7b7d-b8d6-4d27-8b60-ee4047e91304", "sales_owner_id": "419a49b7-d698-4d74-87b6-314cb4da4e7d", "external_ids": [ "string" ] }