Read company identity and lifecycle metadata, then reset a Sandbox when you need
to rebuild its test data. Lifecycle reads require company.view; Reset requires
company.reset. A caller may read lifecycle while being denied Reset.
Use GET /api/v1/companies/{companyId}/members to list the company’s members
with their name, email and role; it requires member.view. A member’s id is
the user ID that task assignees and export-preset ownerUserId take.
Use GET /api/v1/companies/{companyId}/email-branding and
PUT /api/v1/companies/{companyId}/email-branding to read and turn on or off
the company’s email branding. On, the emails AI Insurance sends for the company
carry its logo, primary colour and name; off, the default, they carry AI
Insurance’s look. Reading requires company.view; changing it requires
company.edit. Both answer 404 while email is not turned on for the
company.
Use GET /api/v1/companies/{companyId}/lifecycle to inspect the mode, Owner,
Purpose, Reset eligibility and reason, and last Reset. Only initialized Sandbox
companies can be reset. Live and Retired companies are protected for every caller.
POST /api/v1/companies/{companyId}/reset permanently clears application data
including soft-deleted entities, financial records, forms and packets, file
references, tasks, runs, and operational history. It keeps configuration versions
and drafts, all financial configuration, form templates, file categories, invoice
audit rules, email intake setup, saved views, export presets, company metadata,
API contacts, rollout overrides, users, roles, Go App memberships and API keys.
Broker portal memberships are removed with the Person records they link. Sequence
definitions are retained; numbering restarts at each configured start number.
Company lifecycle receipts, staff access history and minimal Reset receipts remain.
The response is synchronous with deleted row counts and restarted counters. All
database deletions, counter updates and the Reset receipt commit in one transaction;
a failure rolls them back together. Other companies and companyless audit history
are untouched. Cloud storage objects are not deleted.
Stop other Sandbox activity before Reset: concurrent writes can repopulate data.
There is no background job or request replay guarantee. If you lose the response,
inspect lifecycle and its last Reset before deciding whether to retry. An optional
agentLabel identifies your automation in the receipt; it is a self-supplied label.
The same operation is available in app Admin → Data Management, with a
persistent warning. Click Reset Sandbox, then type reset sandbox in the
confirmation dialog to enable Reset Sandbox. Canceling leaves the data
unchanged; a confirmed Reset runs synchronously and shows the result and Last
Reset. In Control Plane Companies → Actions → Reset Sandbox, staff type
reset sandbox to confirm, and the Reset runs as a background lifecycle task.
