Create Submittal

POST /public/v1/projects/{projectId}/submittals

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required

Query parameters

  • skipSubmittalActivityLinking boolean

    Default value is false.

application/json

Body Required

  • providerName string

    Name of 3rd party provider of submittal

    Values are AUTODESK, PROCORE, or EGNYTE.

  • status string

    Submittal status

  • id integer(int64)

    Submittal Id

  • title string

    Submittal title

  • userId string(uuid)

    User Id

  • projectId integer(int64) Required

    SmartPM project Id

  • submittalType object
    Hide submittalType attributes Show submittalType attributes object
    • id integer(int64)

      Id

    • projectId integer(int64) Required

      SmartPM project Id

    • externalId string

      External project Id

    • name string

      Submittal type name

  • submittalPackage object
    Hide submittalPackage attributes Show submittalPackage attributes object
    • description string

      Submittal package description

    • id integer(int64)

      Id

    • title string

      Submittal package title

    • projectId integer(int64) Required

      SmartPM project Id

    • externalId string

      External project Id

  • createdDate string(date-time)

    Created date

  • externalProjectId string

    External project Id

  • number string

    Submittal number

  • updatedDate string(date-time)

    Updated date

  • leadTime integer(int64)

    Lead time (in days)

  • areLinkedActivitiesConfirmed boolean

    Whether linked activities are confirmed

    Default value is false.

  • scheduleImpactStatus string

    Whether submittal impacts the schedule of the project or not

  • submitterReceivedDate string(date-time)

    Submitter received date

  • approvalPublishedDate string(date-time)

    Approval published date

  • submittalLinkedActivities array[object]

    The list of activities linked and affected by the submittal

    Hide submittalLinkedActivities attributes Show submittalLinkedActivities attributes object
    • id integer(int64)

      Id

    • activityId integer(int64) Required

      Activity Id

    • submittal object
  • submittalBallInCourtUsers array[object]

    Ball in court users

    Hide submittalBallInCourtUsers attributes Show submittalBallInCourtUsers attributes object
    • email string

      User email

    • submittal object
      Hide submittal attribute Show submittal attribute object
      • projectId Required
    • name string

      User name

    • id integer(int64)

      Id

  • createdByEmail string

    Email of the user who created the submittal

  • createdByUserName string

    Name of the user who created the submittal

  • scheduleImpactValue integer(int64)

    The number of days that the submittal impacts the schedule

  • costImpactStatus string

    Whether submittal impacts the cost of the project or not

  • costImpactValue number(double)

    The dollar amount that the submittal impacts the project

  • submitterStartDate string(date-time)

    Submitter start date

  • submitterDueDate string(date-time)

    Submitter due date

  • processingStartDate string(date-time)

    Processing start date

  • processingDueDate string(date-time)

    Processing due date

  • processingSentDate string(date-time)

    Processing sent date

  • approvalStartDate string(date-time)

    Approval start date

  • approvalDueDate string(date-time)

    Approval due date

  • estimatedOnSiteDate string(date-time)

    Estimated on site date

  • submittalResponses array[object]

    Submittal responses

    Hide submittalResponses attributes Show submittalResponses attributes object
    • response string

      Reviewer’s response or comments for the submittal

    • id integer(int64)

      Id

    • userId string(uuid)

      User Id

    • submittal object
      Hide submittal attribute Show submittal attribute object
      • projectId Required
    • createdDate string(date-time)

      Created date

    • updatedDate string(date-time)

      Updated date

    • createdByEmail string

      Email of the user who created the submittal response

    • createdByUserName string

      Name of the user who created the submittal response

  • priority string

    Priority

Responses

  • 500 */*

    Internal Server Error

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • response string

      Reviewer’s response or comments for the submittal

    • id integer(int64)

      Id

    • userId string(uuid)

      User Id

    • submittal object
      Hide submittal attribute Show submittal attribute object
      • projectId Required
    • createdDate string(date-time)

      Created date

    • updatedDate string(date-time)

      Updated date

    • createdByEmail string

      Email of the user who created the submittal response

    • createdByUserName string

      Name of the user who created the submittal response

POST /public/v1/projects/{projectId}/submittals
curl \
 --request POST 'https://live.smartpmtech.com/public/v1/projects/{projectId}/submittals' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-COMPANY-ID: string" \
 --data '{"providerName":"AUTODESK","status":"OPEN","id":1001,"title":"Structural Steel Details","userId":"123e4567-e89b-12d3-a456-426614174000","projectId":2001,"submittalType":{"id":1,"projectId":2001,"externalId":"proj-7890","name":"Shop drawing"},"submittalPackage":{"description":"Structural steel connection details and fabrication drawings","id":1,"title":"Structural Steel","projectId":2001,"externalId":"proj-7890"},"createdDate":"2025-05-01T08:00:00+00:00","externalProjectId":"proj-7890","number":"Submittal-2025-001","updatedDate":"2025-05-03T08:00:00+00:00","leadTime":10,"areLinkedActivitiesConfirmed":true,"scheduleImpactStatus":"yes","submitterReceivedDate":"2025-05-03T08:00:00+00:00","approvalPublishedDate":"2025-05-15T08:00:00+00:00","submittalLinkedActivities":[{"id":1,"activityId":25,"submittal":{}}],"submittalBallInCourtUsers":[{"email":"michelle.wilson@constructionco.com","submittal":{},"name":"Michelle Wilson","id":501}],"createdByEmail":"john.smith@constructionco.com","createdByUserName":"John Smith","scheduleImpactValue":10,"costImpactStatus":"yes","costImpactValue":15000.75,"submitterStartDate":"2025-05-01T08:00:00+00:00","submitterDueDate":"2025-05-05T08:00:00+00:00","processingStartDate":"2025-05-07T08:00:00+00:00","processingDueDate":"2025-05-11T08:00:00+00:00","processingSentDate":"2025-05-09T08:00:00+00:00","approvalStartDate":"2025-05-13T08:00:00+00:00","approvalDueDate":"2025-05-17T08:00:00+00:00","estimatedOnSiteDate":"2025-05-27T08:00:00+00:00","submittalResponses":[{"response":"Approved as submitted","id":1,"userId":"123e4567-e89b-12d3-a456-426614174000","submittal":{},"createdDate":"2025-10-27T14:30:00+00:00","updatedDate":"2025-10-29T14:30:00+00:00","createdByEmail":"jane.smith@constructionco.com","createdByUserName":"Jane Smith"}],"priority":"high"}'
Request examples
# Headers
X-COMPANY-ID: string

# Payload
{
  "providerName": "AUTODESK",
  "status": "OPEN",
  "id": 1001,
  "title": "Structural Steel Details",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": 2001,
  "submittalType": {
    "id": 1,
    "projectId": 2001,
    "externalId": "proj-7890",
    "name": "Shop drawing"
  },
  "submittalPackage": {
    "description": "Structural steel connection details and fabrication drawings",
    "id": 1,
    "title": "Structural Steel",
    "projectId": 2001,
    "externalId": "proj-7890"
  },
  "createdDate": "2025-05-01T08:00:00+00:00",
  "externalProjectId": "proj-7890",
  "number": "Submittal-2025-001",
  "updatedDate": "2025-05-03T08:00:00+00:00",
  "leadTime": 10,
  "areLinkedActivitiesConfirmed": true,
  "scheduleImpactStatus": "yes",
  "submitterReceivedDate": "2025-05-03T08:00:00+00:00",
  "approvalPublishedDate": "2025-05-15T08:00:00+00:00",
  "submittalLinkedActivities": [
    {
      "id": 1,
      "activityId": 25,
      "submittal": {}
    }
  ],
  "submittalBallInCourtUsers": [
    {
      "email": "michelle.wilson@constructionco.com",
      "submittal": {},
      "name": "Michelle Wilson",
      "id": 501
    }
  ],
  "createdByEmail": "john.smith@constructionco.com",
  "createdByUserName": "John Smith",
  "scheduleImpactValue": 10,
  "costImpactStatus": "yes",
  "costImpactValue": 15000.75,
  "submitterStartDate": "2025-05-01T08:00:00+00:00",
  "submitterDueDate": "2025-05-05T08:00:00+00:00",
  "processingStartDate": "2025-05-07T08:00:00+00:00",
  "processingDueDate": "2025-05-11T08:00:00+00:00",
  "processingSentDate": "2025-05-09T08:00:00+00:00",
  "approvalStartDate": "2025-05-13T08:00:00+00:00",
  "approvalDueDate": "2025-05-17T08:00:00+00:00",
  "estimatedOnSiteDate": "2025-05-27T08:00:00+00:00",
  "submittalResponses": [
    {
      "response": "Approved as submitted",
      "id": 1,
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "submittal": {},
      "createdDate": "2025-10-27T14:30:00+00:00",
      "updatedDate": "2025-10-29T14:30:00+00:00",
      "createdByEmail": "jane.smith@constructionco.com",
      "createdByUserName": "Jane Smith"
    }
  ],
  "priority": "high"
}
Response examples (500)
{}
Response examples (200)
{
  "response": "Approved as submitted",
  "id": 1,
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "submittal": {},
  "createdDate": "2025-10-27T14:30:00+00:00",
  "updatedDate": "2025-10-29T14:30:00+00:00",
  "createdByEmail": "jane.smith@constructionco.com",
  "createdByUserName": "Jane Smith"
}