PATCH /rest/v1.0/projects/{project_id}/checklist/schedules/{id}

Updates a Checklist (Inspection) Schedule in a specified Project

Servers

Path parameters

Name Type Required Description
id Integer Yes

Checklist Schedule 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.

Request body fields

Name Type Required Description
schedule Object Yes

Checklist Schedule object

schedule.location_id Integer No

The ID of the Location to set on the Schedule.

schedule.specification_section_id Integer No

The ID of the specification section to set on the Schedule.

schedule.first_inspection_due_at String No

Timestamp indicating when the first Inspection in the Schedule should be due. Cannot be in the past.

schedule.frequency String No

The frequency at which Inspections will be created by the Schedule.

Possible values:

  • "once_every_two_weeks"
  • "monthly"
  • "weekly"
  • "yearly"
  • "once"
  • "daily"
schedule.equipment_id String No

The ID of the Equipment to set on the Schedule.

schedule.name String No

The name for the Checklist Schedule.

schedule.point_of_contact_id Integer No

The ID of a User to be set as the of the point of contact on the Schedule

schedule.distribution_member_ids[] Array No
schedule.assignee_ids[] Array No
schedule.responsible_contractor_id Integer No

The ID of a vendor to set as the responsible contractor on the Schedule.

schedule.ends_at String No

Timestamp indicating when the last Inspection in the Schedule should be due. Not used when frequency is once.

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.