POST /rest/v2.0/companies/{company_id}/users/bulk_add
This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
String | 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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
users[] |
Array | Yes |
Array of existing company users with a permission template id and project id that they will be assinged to. The maximum amount per request is 50 user_id, project_id, permission_template_id triplets. If more than 50 objects are sent then a worker will be triggered to perform the action asynchronously. |
users[].project_id |
String | No |
The ID of project to add the user to |
users[].permission_template_id |
String | No |
The ID of the permission template to assign to the user |
users[].user_id |
String | No |
The ID of the user to add |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.