---
updatedAt: 2026-10-30T14:11:59.000Z
agentTools:
  projectIndex: https://docs.sumoquote.com/llms.txt
---

# Create project

Creates a new SumoQuote Project

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "SumoQuote.PublicAPI v2",
    "description": "<table>\r\n              <thead>\r\n                <td>Property</td>\r\n                <td>Description</td>\r\n                <td>Values</td>\r\n              </thead>\r\n              <tbody>\r\n                <tr>\r\n                  <td>HTTP - StatusCode</td>\r\n                  <td>\r\n                    Refer to Mozilla - HTTP response status codes\r\n                  </td>\r\n                  <td>200, 201, 204, 400, 401, 403, 404, 500</td>\r\n                </tr>\r\n                <tr>\r\n                  <td>Message</td>\r\n                  <td>Information messages</td>\r\n                  <td></td>\r\n                </tr>\r\n                <tr>\r\n                  <td>Errors</td>\r\n                  <td>Validation and Error messages</td>\r\n                  <td></td>\r\n                </tr>\r\n                <tr>\r\n                  <td>Data</td>\r\n                  <td>Requested data</td>\r\n                  <td>Schema data</td>\r\n                </tr>\r\n              </tbody>\r\n            </table>",
    "termsOfService": "https://www.sumoquote.com/terms-conditions/",
    "contact": {
      "name": "SumoQuote Support",
      "email": "support@sumoquote.com"
    },
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://api.sumoquote.com"
    }
  ],
  "paths": {
    "/v2/Project": {
      "post": {
        "tags": [
          "Project"
        ],
        "summary": "Create project",
        "description": "Creates a new SumoQuote Project",
        "requestBody": {
          "description": "The payload for the new SumoQuote Project",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/NewProjectRequest"
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewProjectRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/NewProjectRequest"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/NewProjectRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SumoProjectPublicApiResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiResponse"
                }
              }
            }
          },
          "500": {
            "description": "Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProjectIntegration": {
        "type": "object",
        "properties": {
          "companyCamProjectId": {
            "type": "string",
            "nullable": true
          },
          "jobNimbusProjectId": {
            "type": "string",
            "nullable": true
          },
          "jobNimbusProjectType": {
            "type": "string",
            "nullable": true
          },
          "jobProgressProjectId": {
            "type": "string",
            "nullable": true
          },
          "jobProgressProjectType": {
            "type": "string",
            "nullable": true
          },
          "acculynxJobId": {
            "type": "string",
            "nullable": true
          },
          "dynamicProjectId": {
            "type": "string",
            "nullable": true
          },
          "roofLinkProjectId": {
            "type": "string",
            "nullable": true
          },
          "hoverProjectId": {
            "type": "string",
            "nullable": true
          },
          "roofleProjectId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SumoMetadata": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SumoProject": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "projectIdDisplay": {
            "type": "string",
            "nullable": true
          },
          "projectIdSystemGenerated": {
            "type": "string",
            "nullable": true
          },
          "customerFirstName": {
            "type": "string",
            "nullable": true
          },
          "customerLastName": {
            "type": "string",
            "nullable": true
          },
          "companyName": {
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "province": {
            "type": "string",
            "nullable": true
          },
          "emailAddress": {
            "type": "string",
            "nullable": true
          },
          "phoneNumber": {
            "type": "string",
            "nullable": true
          },
          "intakeDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "nextCallback": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "wonDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "lostDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "estimate": {
            "type": "number",
            "format": "double"
          },
          "estimator": {
            "type": "string",
            "nullable": true
          },
          "estimatorId": {
            "type": "string",
            "nullable": true
          },
          "primaryContact": {
            "type": "string",
            "nullable": true
          },
          "primaryContactId": {
            "type": "string",
            "nullable": true
          },
          "projectState": {
            "type": "string",
            "nullable": true
          },
          "isSample": {
            "type": "boolean"
          },
          "primaryImage": {
            "type": "string",
            "nullable": true
          },
          "projectIntegrations": {
            "$ref": "#/components/schemas/ProjectIntegration"
          },
          "portalId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "portalEnabled": {
            "type": "boolean"
          },
          "portalInvitationsActive": {
            "type": "boolean"
          },
          "metaData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SumoMetadata"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PublicApiResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Information Message",
            "nullable": true
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Error messages",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WorkType": {
        "enum": [
          0,
          1
        ],
        "type": "integer",
        "format": "int32"
      },
      "NewProjectRequest": {
        "required": [
          "addressLine1",
          "customerFirstName"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "projectId": {
            "type": "string",
            "nullable": true
          },
          "customerFirstName": {
            "type": "string"
          },
          "customerLastName": {
            "type": "string",
            "nullable": true
          },
          "phoneNumber": {
            "type": "string",
            "nullable": true
          },
          "emailAddress": {
            "type": "string",
            "format": "email",
            "nullable": true
          },
          "addressLine1": {
            "type": "string"
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "province": {
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "customerFullName": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "projectIntegration": {
            "$ref": "#/components/schemas/ProjectIntegration"
          },
          "salespersonId": {
            "type": "string",
            "nullable": true
          },
          "layoutId": {
            "type": "string",
            "nullable": true
          },
          "salespersonEmail": {
            "type": "string",
            "format": "email",
            "nullable": true
          },
          "intakeDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "metadata": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SumoMetadata"
            },
            "nullable": true
          },
          "projectType": {
            "$ref": "#/components/schemas/WorkType"
          },
          "companyName": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SumoProjectPublicApiResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Information Message",
            "nullable": true
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Error messages",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/SumoProject"
          },
          "continuation": {
            "type": "string",
            "description": "Continuation Token",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "description": "JWT Authorization header using the Bearer scheme.",
        "scheme": "bearer"
      },
      "ApiKey": {
        "type": "apiKey",
        "description": "An API Key generated from the SumoQuote application.",
        "name": "sq-api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiKey": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```