post
https://yoursubdomain.workbright.com/api/partner/accounts/clone
Clones an existing template within a Partner Bundle to a new subdomain.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Partner Subdomain Cloning
Programmatically provision a new WorkBright subdomain by cloning the configuration of an existing template subdomain. This lets partners stand up pre-configured accounts (workflows, document packets, and settings inherited from the template) without manual setup. Note: This is only allowed for approved partner at this time.
Overview
| Method | POST |
| Endpoint | /api/partner/accounts/clone |
| Base URL | https://{partner-main-subdomain}.workbright.com |
| Auth | API Key (header) |
| Content-Type | application/json |
Both the endpoint host and the API key are tied to your main partner subdomain. Issue the request against your main subdomain — never against a template subdomain. The template you want to clone is specified in the request body, not the URL.
How It Works
- Your WorkBright Customer Representative sets up the templates. Your WorkBright Customer Representative provisions one or more template subdomains, each pre-configured with the settings you want new accounts to inherit.
- You call this endpoint from your main subdomain. Using your main partner subdomain and its API key, you request a clone and name the specific template subdomain you want to copy.
- You receive an immediate response with
status: pending. Provisioning runs asynchronously. The response also returns the API key for the new account — capture and store it securely). - A webhook confirms the outcome. When provisioning finishes, an [
account.provisioned] webhook event fires with astatusofsucceededorfailed.
Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
template | String | Yes | Subdomain of the template account to clone from. Templates are provisioned for you by your WorkBright representative; specify the one whose configuration you want the new account to inherit. |
subdomain | String | Yes | Desired subdomain for the new account. Must be globally unique and URL-safe (lowercase letters, numbers, and hyphens). |
name | String | Yes | Human-readable display name for the new account. |
account_type | String | No | When specified and set as test, the provisioned subdomain will not count towards usage and will enable a sandbox version of Document Verification. This should not be used for production instances. |