INGENIOUS.API

Create submittal

post
https://{subdomain}.ingenious.build/api/v2/pub/submittals

Creates submittal

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

Status of the submittal. Status different than draft might require additional fields to be set.

string
required

The project ID to which the submittal belongs.

string
required

The package ID to which the submittal belongs.

string
required

The submittal type ID defined Project Settings.

string
required

The title of the submittal. Often the title contains the material, type, and jobsite location.

string | null
Defaults to null

The external ID of the submittal, identifies resource in source platform.

string | null
Defaults to null

The source platform from which the submittal is being created.

string | null
Defaults to null

The URL to the submittal in the source platform.

string | null
Defaults to null

The ID of the contractor responsible for this submittal. Required for status pending_submission

string | null
Defaults to null

Additional information further describing the submittal.

date | null
Defaults to null

Used to calculate the schedule dates for the submittal based on the final Approval Date. Date in Y-m-d format.

date | null
Defaults to null

Date materials related to submittals are required to be on-site. Date in Y-m-d format.

integer | null
≥ 1
Defaults to null

Amount of days/weeks for the materials/services related to the submittal to arrive.

string | null
enum
Defaults to null

Unit of time for the material lead time. Either days or weeks.

Allowed:
integer | null
≥ 1
Defaults to null

Amount of days/weeks reviewers have to review a given submittal.

string | null
enum
Defaults to null

Unit of time for the internal review time. Either days or weeks.

Allowed:
integer | null
≥ 1
Defaults to null

Amount of days/weeks official reviewers has to review a given submittal.

string | null
enum
Defaults to null

Unit of time for the design review time. Either days or weeks.

Allowed:
integer | null
≥ 1
Defaults to null

Amount of days/weeks submittal documentation must be submitted for review by.

string | null
enum
Defaults to null

Unit of time for the contractor review time. Either days or weeks.

Allowed:
integer | null
≥ 1
Defaults to null

Amount of days/weeks reviewers have to review a given submittal.

string | null
enum
Defaults to null

Unit of time for the submittal manager review time. Either days or weeks.

Allowed:
integer | null
≥ 1
Defaults to null

Amount of days/weeks the Submittal Manager has to review the approved submittal and ask for clarification or close and distribute.

string | null
enum
Defaults to null

Unit of time for the submittal approval review time. Either days or weeks.

Allowed:
string | null
Defaults to null

Ball in Court person ID. If not provided, it will be set to the API user ID.

impacted_party_ids
array of strings | null
Defaults to null

Array of person IDs that are impacted.

impacted_party_ids
document_ids
array of strings | null
Defaults to null

Uploaded document IDs associated with the submittal. To be uploaded via /v2/pub/files endpoint first.

document_ids
string | null
Defaults to null

Official reviewer person ID.

additional_reviewers
array of objects | null
Defaults to null

List of additional reviewers and its metadata.

additional_reviewers
string | null
Defaults to null

Person ID of submittal manager.

Responses
201

Successful operation

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity

500

Internal server error

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 3 months ago

Did this page help you?