POST /rest/v1.0/companies/{company_id}/app_configurations

Create new app configuration for a specified project

Servers

Path parameters

Name Type Required Description
company_id Integer Yes

Unique identifier for the company.

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
sort String No

Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter.

Possible values:

  • "project_count"
  • "title"
  • "created_by"
  • "created_at"
  • "updated_at"

Request body fields

Name Type Required Description
applies_to_all_projects Boolean No

Apply the app configuration to all projects under a company ( if set to true, project_ids field must be blank )

instance_configuration Object Yes

App configuration values for a set of projects.

project_ids[] Array No

A list of projects which will have the app configuration

applies_to_company Boolean No

Apply the app configuration to be available from company routes

app_installation_id Integer Yes

App Installation ID

title String Yes

Single title for app configurations

company_id Integer Yes

Company ID

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.