Safety rules
- Use an agency API key, never a client key, for partner operations.
- Confirm the target client ID before every cross-workspace mutation.
- Treat client creation, plan changes, publish, rollback, and feature updates as administrative actions.
- Log the agency actor, client ID, operation, and response.
- Do not assume a normal workspace key can access partner endpoints.
Client lifecycle
GET /api/v1/public/partner/settings returns signup settings, launch settings, the experience draft and its versions, and PUT /api/v1/public/partner/settings changes any part. Send experience to save a draft, publish: true to publish it, and rollback_to with a version ID to restore a version. Retain the version ID so rollback targets a known revision. The steps run in this order: signup, draft, publish, rollback.
Who can change agency settings
Reading agency data works with any agency key. Changing signup settings, saving or publishing an experience, and rolling back (allPUT /partner/settings) need an agency owner or admin. For an API key, that is the role of the person who created the key, checked on every request: a key created by a manager, or by someone who has since been demoted or removed, gets 403.
Client feature settings
GET /api/v1/public/partner/clients?id=CLIENT_ID reads a client’s feature settings, and PATCH /api/v1/public/partner/clients/{client_id} changes them (send features; send branding to change its branding in the same call). Together they read and change what a client workspace can use. The values are the same switches the agency console shows, and they take effect for the client straight away. The settable features are email, sms, voice, linkedin, whatsapp, campaigns, agents, inbox, leads, knowledge_base and settings.
public_api, white_label and ai_copilot follow the workspace plan and cannot be switched for one client, so they are refused with 422 (the response names them). An unknown key is also 422, and a request that contains any refused key changes nothing. Enabling a feature that the client’s assigned plan does not include is refused with 403.
Client list fields
GET /api/v1/public/partner/clients returns a fixed set of fields per client (add include=revenue for the trailing 30 day revenue overview): id, name, status, created_at, owner and plan details, campaign_count, monthly_revenue, health, billing_mode, package and billing status, and logo_url. Internal notes and billing identifiers stay in the agency console.
Plan creation, update, and deletion change resale configuration. Require explicit confirmation and retain an audit record before submitting these calls.