9 Jul 2024
BuildingConnected API: Create Invites
In addition to BuildingConnected webhook API, the endpoints to create Invites are also exposed. It allows you to add bidders to the bidPackage, working the same way as inviting bidders by email address in BuildingConnected UI.
The following two endpoints are added:
- POST Invites: invites by emails to one bidPackage
- POST Invites bulk: invites by emails to group of bidPackages
Note: in this release, adding a bidder by native search/recommended bidder feature is not supported.
One Invite is a group of bidders in the same company. The email address of the bidder may or may not be claimed (associated) with a BuildingConnected account. The unclaimed (unassociacted) user is called “ghost” user. API provides placeholderCompanyName to handle the scenario when the bidder is a ghost user. The following picture illustrates the workflow.
Please check the following materials for more details:
- Field Guide - added a section about Invites
- API References - added two endpoints
- Postman collection - updated with the two endpoints.