PATCH /rest/v1.0/projects/{project_id}/forms/{id}

Update the specified Form.

Servers

Path parameters

Name Type Required Description
id Integer Yes

Form ID

project_id Integer Yes

Unique identifier for the project.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
send_emails Boolean No

Designates whether or not emails will be sent (default false)

Request body fields

Name Type Required Description
form Object Yes
form.prostore_file_ids[] Array No

An array of Prostore File IDs. The Prostore Files will be associated with the Form as attachments

form.name String No

The Name of the Form

form.description String No

The Description of the Form

form.fillable_pdf_prostore_file_id Integer No

Form's Fillable PDF. fillable_pdf_prostore_file_id and fillable_pdf_upload_id are mutually exclusive.

form.upload_ids[] Array No

An array of Upload UUIDs. The Uploads will be transformed into the Form's attachments

form.private Boolean No

The Private status of the Form

Default value: false

form.fillable_pdf_upload_id String No

The specified Upload is saved as the Form's Fillable PDF. fillable_pdf_prostore_file_id and fillable_pdf_upload_id are mutually exclusive.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.