POST /rest/v1.1/companies/{company_id}/users/bulk_remove
This endpoint allows company users to be bulk removed from multiple projects.
Servers
- https://api.procore.com
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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
users[] |
Array | Yes |
Array of existing company users with a project id that they will be removed from. The maximum amount per request is 1000 user_id, project_id duplets. If more than 1000 objects are sent then a worker will be triggered to perform the action asynchronously. |
users[].project_id |
Number | No |
The ID of project to add the user to remove from |
users[].user_id |
Number | No |
The ID of the user to remove |
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.