Skip to main content
POST
/
landlords
Create a landlord
curl --request POST \
  --url https://app.lanten.co/api/open/v1/landlords \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "fullAddress": "<string>",
  "status": "active",
  "notes": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "fullAddress": "<string>",
    "status": "active",
    "notes": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Body

application/json
name
string
required
Maximum string length: 260
email
string<email> | null
phoneNumber
string | null
Maximum string length: 160
fullAddress
string | null
Maximum string length: 560
status
enum<string>
default:active
Available options:
active,
inactive
notes
string | null

Response

Landlord created

data
object