Tenant Management

Manage tenants within organizations. Requires ADMIN permissions.

Create Tenant

POST /api/tenant or POST /api/organization/:orgId/tenant

name * are required parameters	data type	description
body.name*	string	The display name of the new tenant
body.slug	string	A unique URL-friendly identifier

Update Tenant

PUT /api/tenant/:tenantId or PUT /api/organization/:orgId/tenant/:tenantId

name * are required parameters	data type	description
tenantId*	string	The unique identifier of the tenant
body.name	string	Updated display name

Audio Notes Settings

body.audioNotes is optional. When supplied, send the complete object:

Property	Type	Description
autoTranscribe	boolean	Whether recordings are automatically transcribed on the device.

autoTranscribe is required; unknown properties, including the removed audience, userIds, and roleIds settings, are rejected. Invalid settings return 400; updating settings while AUDIO_NOTES is disabled returns 403. The feature can be enabled in the same request with "featureChange": [{ "feature": "AUDIO_NOTES", "enable": true }].

Omit audioNotes to leave saved settings unchanged. Automatic transcription defaults to disabled. Audio Note fields are available to users with existing form permissions when the target's AudioNotes feature is enabled.

Move Tenant

PUT /api/tenant/:tenantId/move

name * are required parameters	data type	description
tenantId*	string	The unique identifier of the tenant to move
body.orgId*	string	The destination organization ID

Clone Tenant

POST /api/tenant/:tenantId/clone or POST /api/organization/:orgId/tenant/:tenantId/clone

name * are required parameters	data type	description
tenantId*	string	The unique identifier of the tenant to clone
body.name*	string	The display name for the cloned tenant

Delete Tenant

DELETE /api/tenant/:tenantId or DELETE /api/organization/:orgId/tenant/:tenantId

name * are required parameters	data type	description
tenantId*	string	The unique identifier of the tenant to delete

Examples

bash

curl -X POST "https://app.wombat.software/api/organization/:orgId/tenant" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..." \
  -d '{"name": "North Region"}'