/
API - Tenant

API - Tenant

Oct 09, 2019



Creating a new tenant

Endpoint

/api/v1/tenants

Method

POST

Parameters

name

Mandatory

max length 255

domain

Mandatory

max length 255

timezone

Mandatory



language

Mandatory



email

Mandatory



county

Mandatory



feature_plan_id

Mandatory

NEW - set a predefined feature plan id 

configs

Optional

A key-value dictionary with configs to be set on tenant

Response examples.

201

{
"meta": {"status": 200,
"message": "Created"
}, "data": {"id": 42
}
}

400

{
"meta": {"status": 400,
"message": "Missing required params"
}
}

500

{
"meta": {"status": 500,
"message": "Data insertion may break a database constraint"
}
}

Change feature plan 


Feature plan doc

Endpoint

/api/v1/tenants/<tenant_id>/feature_plan

Method

POST

Parameters

feature_plan_id

Mandatory

Example

curl -X POST \ https://<EVOLUX_DOMAIN>/api/v1/tenants/100/feature_plan \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -H 'token: <EVOLUX_TOKEN>' \ -d '{"feature_plan_id": 5}'

Response example

200

{
     "meta": {
          "status": 200,
          "message": "OK"
     }
}