Workspaces

Complete workspace onboarding

Records that onboarding is finished by setting onboarded_at; calling it again keeps the first time. Needs the owner or admin role.

POST
/workspace/onboarding/completion

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

application/json

Success

idstringrequired

Workspace id. Send it in the bavlio-workspace header to act in this workspace.

org_idstringrequired

Tenant id (a UUID) that scopes the workspace's lead data.

namestringrequired

Company name.

sellsstringrequired

What the company sells, in one line.

problemsstring[]required

Problems the company solves for its customers.

customersstring[]required

Names of current customers; leads at these companies are skipped.

domainstring | nullrequired

Company website domain; null when there is none.

attributionenum<string> | nullrequired

Where the user heard about Bavlio; null when not recorded.

Available options: chatgpt, claude, perplexity, google, reddit, linkedin, youtube, friend, accelerator, other

timezonestringrequired

IANA time zone of the outreach schedule; UTC until one is set.

week_startenum<string>required

First day of the week in Bavlio's calendars.

Available options: monday, sunday

working_daysenum<string>[]required

Days of the week outreach runs on.

Available options: sunday, monday, tuesday, wednesday, thursday, friday, saturday

working_hoursobjectrequired

Hours of each working day during which outreach runs.

onboarded_atstring | nullrequired

When onboarding was completed, as an ISO 8601 timestamp; null until then.

created_atstringrequired

When the workspace was created, as an ISO 8601 timestamp.