BOS by Betazu←Back to BOS
BOS API/Leads

Leads API

Create, retrieve, update, and delete leads in your BOS workspace.

Authentication

Every request to the Leads API must include a valid BOS API key.

Authorization: Bearer $BOS_API_KEY

Your API key must have the scope required by the endpoint you are calling.

Base URL

All BOS API requests use the following base URL.

https://www.betazu.com/api/v1

Endpoints

GET/api/v1/leads

List leads

Retrieve leads available to your authenticated BOS application.

bos:leads:read
POST/api/v1/leads

Create a lead

Create a new lead in your BOS workspace.

bos:leads:create
PATCH/api/v1/leads/:id

Update a lead

Update an existing lead.

bos:leads:update
DELETE/api/v1/leads/:id

Delete a lead

Delete an existing lead.

bos:leads:delete

Example request

Retrieve leads using your BOS API key.

curl https://www.betazu.com/api/v1/leads \
  -H "Authorization: Bearer $BOS_API_KEY"

Store your API key securely

Store the secret generated by BOS as an environment variable. Never expose it in browser-side code or commit it to source control.

BOS_API_KEY=bz_live_xxxxxxxxxxxxxxxxxxxxxxxxx

Required scopes

Each operation requires the corresponding permission on your API key.

OperationScope
Read leadsbos:leads:read
Create leadsbos:leads:create
Update leadsbos:leads:update
Delete leadsbos:leads:delete
← API keysDocumentation home →