From Bright Pattern Documentation
Jump to: navigation, search

Export Tenant

This method returns tenant data in a .zip file. This data can be subsequently imported into another cluster (see method Import tenant), or it can be used as a template for the creation of a new tenant (see method Create tenant from template). Data includes all tenant configuration (e.g., users, phones, services, scenarios, calling lists, etc). It does not include historical reporting DB contents, trunks, association of access numbers with trunks, audio, or CPA recordings.

Note that a tenant must be deactivated before it can be exported. For more information, see the Bright Pattern Contact Center Service Provider Guide, section Tenants Overview.

Request

URL

http[s]://<host>/configapi/v2/tenant/<tenant_url>

HTTP Method

GET

Response

Returns either tenant data in a zip file or an error message.

Response Codes

Code Description
200 Tenant data (content-type: application/ZIP)
404 Tenant not found
< Previous | Next >