Tenants
List tenants
GET https://cp.elovade.cloud/api/v1/tenants?page=1
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
Path Parameters
per_page
Integer
Items to show per page
page
Integer
Current page
Create tenant
POST https://cp.elovade.cloud/api/v1/tenants
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--data "{json}" \
Request Body
parent_id
String
UUID of parent tenant. If none is provided, the new tenant will be created on the highest level
partner
Boolean
Whether the tenant should be of type partner. By default, new tenants are created as customer
allow_subpartners
Boolean
Whether the new tenant should be allowed to create partners. This parameter can only be set if partner=true. By default, new tenants are not allowed to create partners
name*
String
Tenant name
customer_number
String
Tenant customer number
String
Tenant email address. The parameter is required if create_user=true
phone
String
Tenant phone number
website
String
Tenant website URL
vat
String
Tenant VAT number
address
String
Tenant address
city
String
Tenant city
region
String
Tenant region
postal_code
String
Tenant postal code
tenant_foreign_id
String
Foreign tenant ID from external system
create_user
Boolean
Whether to create a new user along with the tenant. The tenant name and email will be used to create the user. The tenant email then must not yet be used by another user in the system
send_email
Boolean
Whether to send an email with credentials to the new user, created with the tenant
Show tenant
GET https://cp.elovade.cloud/api/v1/tenants/{tenant}
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
Update tenant
PUT https://cp.elovade.cloud/api/v1/tenants/{tenant}
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PUT \
--data "{json}" \
Request Body
name*
String
Tenant name
customer_number
String
Tenant customer number
String
Tenant email address
phone
String
Tenant phone number
website
String
Tenant website URL
vat
String
Tenant VAT number
address
String
Tenant address
city
String
Tenant city
region
String
Tenant region
postal_code
String
Tenant postal code
tenant_foreign_id
String
Foreign tenant ID from external system
Delete tenant
DELETE https://cp.elovade.cloud/api/v1/tenants/{tenant}
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
--request DELETE \
List tenant EL mailarchive instances
GET https://cp.elovade.cloud/api/v1/tenants/{tenant}/el-mailarchive/instances?page=1
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
Path Parameters
per_page
Integer
Items to show per page
page
Integer
Current page
List tenant users
GET https://cp.elovade.cloud/api/v1/tenants/{tenant}/users?page=1
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
Path Parameters
per_page
Integer
Items to show per page
page
Integer
Current page
Last updated