Update an existing tenant

put

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}

Updates the tenant record and returns the updated tenant.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Body Params

Data to pass to update and existing tenant. Contains all core configuration, authentication and options set at the Tenant level

businessType

string

enum

The type of the business. This will be supplementary to Tenant type when selected type of business.

categoryCode

int64

Four digit Category code for this tenant.

companyNumber

string

length between 5 and 20

Legal company number of the tenant

string

Primary email address of the tenant

exportedTenantConfigurations

string

Optional. It is tenant detail like wallet type, wallet, admin users exported Tenant Configuration as JSON

industrialClassification

string

length between 3 and 50

industrialSector

string

length between 3 and 50

institution

string

length between 3 and 3

^[A-Z]{3}$

Optional. The accountable institution that the tenant falls under

merchantId

string

Merchant Id used for some card payment types to the tenants wallet

name

string

length between 3 and 50

Name of the tenant - typically company name

phone1

string

required

^[0-9]{8,16}$

Tenants primary phone number

status

string

enum

Status of the eclipse organisation. ACTIVE:Organisation is active, INACTIVE:Organisation is in active, BARRED:Organisation is in barred

Allowed:

taxNumber

string

length between 3 and 20

Tax number of the tenant

tenantId

int64

Unique identifier for a tenant. System generated upon creation of a new tenant. Should be passed as a path parameter for many of the API's which are specific to the tenant

tenantSetupTemplate

string

Tenant setup config template. if value is passed then tenant will be updated based on the template

tradingName

string

length between 3 and 50

vatNumber

string

VAT number of Tenant

version

int32

required

≥ 0

A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.

Responses

400

Bad Request

200OK

404Tenant not found

500Internal Server Error