Create Project (V3)

Creates a new project with the provided data and returns its global id. Unlike v2 (POST /api/v2/pub/projects), all normally-required fields (including name and base_currency) are required regardless of status — External Pending projects are no longer exempt.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name of the project

string | null
enum
Defaults to feasibility

Status of the project, as a kebab-case slug (e.g. "external-pending").

Allowed:
string | null

Custom ID of the project

string
required

Base Currency of the project. Should be iso3 format

string | null

Scope of the project

string | null

Exclusions from the Scope of the project

string | null

ID of the client contact person

string | null
enum

Sector / Industry of the Project, as a kebab-case slug (e.g. "multi-family" for "Multi-Family"). This list is configurable per workspace under Settings > Sector/Industry; the values below are the defaults.

string | null
enum
Allowed:
string | null

Name of the Project Type. If none found it will be ignored

string | null

Primary tag of the Project

string | null

Secondary tag of the Project. Can be a string of tags divided by commas

string | null

ID of the office location that has to be attached to the Project. If none found it will be ignored

string | null

ID of the business unit that has to be attached to the Project. If none found it will be ignored

date | null

This is the anticipated or expected project start date. This date is the initial placeholder and can be updated and modified in the Schedule Module

date | null

This is the anticipated or expected project finish date. This date is the initial placeholder and can be updated and modified in the Schedule Module

string | null

ID of the project phase that has to be attached to the Project.

string | null

ID of the client accounting company. Required if Accounting Company selection for Project Creation is enabled

Headers
string
required
Responses

400

Bad Request

401

Unauthorized

422

Request validation error

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json