Beta version of the API documentation is available here.
This article is intended for Partners that:
have the list of buyers for the marketplace being updated in a external data source and
want to synchronize their buyers into Builtfirst and
have the technical expertise to use an API
The API allows Partners to post new buyers into Builtfirst as well as delete them.
To use this API, please contact us at support@builtfirst.com to have this feature enabled. You'll need to provide the following parameters:
organization-api-key
community_id
Post buyer user
Curl example:
curl --request POST \
--url https://api.builtfirst.com/api/v3/managers/communities/[community_id]/users \
--header 'X-API-Key: [organization-api-key]' \
--header 'content-type: application/json' \
--header 'profile: partner' \
--data '{
"data": {
"attributes": {
"users": [
{
"organization_name": "Org name 1",
"organization_website": "https://myorg.com",
"company_external_id": "unique_org_id",
"email": "user_email@myorg.com",
"domain": "myorg.com",
"user_external_id": "unique_user_id"
}
]
}
}
}'
The users can be posted in bulk. When a user is posted, the system will whitelist the user or re-enable them if that user was in the platform already.
Delete buyer user
Curl example:
curl --request DELETE \
--url 'https://api.builtfirst.com/api/v3/managers/communities/[community_id]/users?filter[user_external_id]=user_external_id1,user_external_id2' \
--header 'X-API-Key: [organization-api-key]' \
--header 'content-type: application/json' \
--header 'profile: partner'
The users can be posted in bulk. When a user is deleted, the system will delete the record if the user has not yet joined Builtfirst. Otherwise, the user will be deactivated and blocked from logging in.