Skip to main content

TenantModel

Tenant profile.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"address": "String",
"city": "String",
"code": "String",
"created_on": "String",
"email": "String",
"id": "Integer",
"is_active": "Boolean",
"name": "String",
"phone": "String",
"state": "String",
"truck_limit": "Integer",
"zip": "String"
}

Fields​

address String, Required

Street address.

  • At least 1 and no more than 256 characters.

city String, Required

Address locality (e.g. city).

  • At least 1 and no more than 86 characters.

code String, Required

Facility identifier.

  • At least 1 and no more than 64 characters.

created_on String, Required

Timestamp of creation (must be in past).

  • Date occurring in the past in an ISO 8601 compatible format.

email String, Required

Email address.

  • Valid email address.

id Integer, Required

Resource identifier.

is_active Boolean, Required

Records marked inactive are treated as deleted (soft delete).

  • One of 0, 1, True, False (case insensitive).

name String, Required

Name (free text).

  • At least 1 and no more than 64 characters.

phone String, Required

Phone number (free text).

  • At least 7 characters, not more than 15.

state String, Required

Address region (e.g. state).

  • At least 1 and no more than 32 characters.

truck_limit Integer, Required

Maximum trucks configurable for tenant.

  • Greater than or equal to 0.

zip String, Required

Postal code (may include letters and symbols).

  • At least 1 and no more than 86 characters.