Documentation

Create Project

POST /projects/{site_id}/create

Creates a new project within the specified site.

Path Parameters

Parameter Type Required Description
site_id string Yes Site ID where the project will be created

Request Body

Field Type Required Description
name string Yes Project name
start_date string or null No Project start date in YYYY-MM-DD format.
end_date string or null No Project end date. Supply a start date and use a date on or after it.
description string No Project description
status string No Project status. Defaults to active. Allowed values are active, canceled, completed, delayed, inactive, needs_changes, and preliminary.

Response

Success Response (200 OK)

data contains the created project. The caller must be an active member of a site with Projects enabled. Site settings can limit creation to users with site-wide project edit access.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to create projects on this site
  • 404 Not Found: Site with the specified ID does not exist

See the Projects API overview for related endpoints.