API Reference
Before getting started
Almost all of the APIs listed here need the following details.
-
Site ID
-
API Key
API Root url
https://api.bullet.so/api/v1
Get a list of all members for a specific site
shell
GET /sites/:site_id/members/
Add a member to a site
Note: Adding new segments is not possible via API. You need to add new segments from Dashboard. You can only pass existing segments from API.
shell
POST /sites/:site_id/members/
{
"name": "John Doe",
"email":"[email protected]",
"allowedSegments":["free","vip"]
}
Update a member's information
shell
PATCH /sites/:site_id/members/:email
{
"name": "John Doe",
"allowedSegments":["free","vip"]
}
Add a member to a specific segment
Note: Adding new segments is not possible via API. You need to add new segments from Dashboard. You can only pass existing segments from API.
shell
POST /sites/:site_id/members/:email/segments
{
"allowedSegments":["premium"]
}
Remove segment from a member
shell
DELETE /sites/:site_id/members/:email/segments
{
"allowedSegments":["premium"]
}
Remove a member from a site
shell
DELETE /sites/:site_id/members/:email