Skip to main content
POST
/
api
/
tenants
/
list
Create a tenant
curl --request POST \
  --url https://api.propops.app/api/tenants/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant_name": "Tenant_001",
  "csrf_token": "abc123def456",
  "tenant_address_id": 5,
  "tenant_number_primary": "07700000003",
  "tenant_number_work": "01200000002",
  "tenant_email": "tenant001@example.com"
}
'
{
  "success": true,
  "message": "Operation completed successfully",
  "tenant_id": 100,
  "tenant_uuid": "990e8400-e29b-41d4-a716-446655440001"
}

Authorizations

​
Authorization
string
header
required

All API requests must include a valid Bearer token in the Authorization header. Tokens are 64-character SHA-256 session hashes issued by the PropOps authentication system.

Example:

Authorization: Bearer a1b2c3d4e5f6...

Body

application/json
​
tenant_name
string
required
Example:

"Tenant_001"

​
csrf_token
string
required
Example:

"abc123def456"

​
tenant_address_id
integer | null
Example:

5

​
tenant_number_primary
string | null
Example:

"07700000003"

​
tenant_number_work
string | null
Example:

"01200000002"

​
tenant_email
string<email> | null
Example:

"tenant001@example.com"

Response

Tenant created

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"

​
tenant_id
integer
Example:

100

​
tenant_uuid
string<uuid>
Example:

"990e8400-e29b-41d4-a716-446655440001"