Shareable partner guide

Partner Connectivity API

Create a workspace, choose a plan and incentive credits, add members, and allocate credits per member. Each member has a separate credit wallet and separate Studio / Research / social operations under the same workspace.

Endpoints

POST https://busme.synczersolutions.com/api/partners/v1/workspaces — create workspace + owner
POST https://busme.synczersolutions.com/api/partners/v1/workspaces/{tenantId}/members — add member (+ optional credits)
GET https://busme.synczersolutions.com/api/partners/v1/workspaces/{tenantId}/members — list members & balances
POST https://busme.synczersolutions.com/api/partners/v1/workspaces/{tenantId}/credits — grant / allocate / transfer credits

Auth headers

Authorization: Bearer bm_live_YOUR_SECRET
Content-Type: application/json
X-Partner-Domain: yoursite.com

Select plan + credit amount

On workspace create, send plan and incentiveCredits. On members/credits calls, send allocateCredits / amount with optional grantCredits / grantFirst.

plan: free · starter · growth · agency
Incentive / allocate amounts capped by partner max (default 200 per grant call)

1. Create workspace

POST /api/partners/v1/workspaces

{
  "businessName": "Amarescent Boutique",
  "websiteUrl": "https://amarescent.com",
  "owner": {
    "email": "owner@amarescent.com",
    "name": "Alex Owner",
    "password": "choose-a-strong-password"
  },
  "plan": "starter",
  "incentiveCredits": 75
}

Save tenant.id and owner.id from the response.

2. Add member + credits

POST /api/partners/v1/workspaces/{tenantId}/members

{
  "email": "editor@amarescent.com",
  "name": "Sam Editor",
  "password": "secure-pass-123",
  "role": "MEMBER",
  "allocateCredits": 40,
  "grantCredits": true
}

grantCredits: true tops up the pool (within partner max) then allocates to that member. Omit it to spend from the existing workspace pool only.

3. Top up a member

POST /api/partners/v1/workspaces/{tenantId}/credits

{
  "toUserId": "member-user-id",
  "amount": 25,
  "grantFirst": true
}

Full markdown for partners

A complete shareable document (cURL examples, errors, flow) is available from the BusMe team as PARTNER-API.md, and mirrored on this page after deploy.

Website catalog API · Developers hub