Connect a workspace
Connect a provider once, then use the returned workspace_id in later
orders and pool attachments. You do not need an Idempotency-Key for
this request. An exact reconnect reuses the existing workspace.
For Smartlead, connect the main workspace with its main API key and a
label. Do not send a client_id or customer object here. Add
client_id to an order only when that order belongs to a Smartlead
client. The Smartlead login email and password are optional, but they
must be sent together. They are saved on the workspace and never sent
with an order.
If an EmailBison target already belongs to a normal Peeker workspace,
this request returns workspace_promotion_required. Repeat it with
promote_existing: true to let the Partner API use that same workspace.
With a sandbox key, Peeker checks credential shape and stores the submitted placeholder values, but creates a local provider identity without calling the sequencer. Never submit production provider keys to sandbox.
Authorizations
Partner API key (pk_live_… or pk_test_…).
Body
- EmailBison
- Instantly
- Smartlead
- PlusVibe
emailbison Set true to reuse an existing Peeker EmailBison workspace with Partner API (not copy it).
Optional partner-owned tracking data. It does not create a Peeker user or affect routing.
Response
Exact existing workspace target reused.