API - Tenant

Owned by Sergio Filipe (Unlicensed)
Last updated: Oct 09, 2019 by Francisco Evangilo (Unlicensed)


Creating a new tenant

Endpoint/api/v1/tenants
MethodPOST

Parameters

nameMandatorymax length 255
domainMandatory

max length 255

timezoneMandatory
languageMandatory


emailMandatory
countyMandatory
feature_plan_idMandatoryNEW - set a predefined feature plan id 
configsOptionalA 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
MethodPOST

Parameters

feature_plan_idMandatory

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"
     }
}