Create profile

Creates a new profile for an individual or entity (tenant, landlord, guarantor) in the system.

Profiles represent the people or organizations involved in property management relationships.
They can be associated with contracts through profile_contracts relationships.

Profile Contract Association

You can associate a profile with a contract at creation time by providing:

  • leasing_contract_id: Associates the profile with a leasing contract
  • management_contract_id: Associates the profile with a management contract

Automatic Nature Setting

The profile nature is automatically set based on contract association:

  • When creating with leasing_contract_id, nature defaults to 'physical_tenant' unless explicitly set to a guarantor type
  • When creating with management_contract_id, nature is always set to 'landlord'

Important Nature Constraints

  • The nature cannot be changed once set via the update endpoint
  • Validation errors will occur if attempting to associate a profile with incompatible contracts
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
profile
object
required
string

ID of a leasing contract to associate with this profile.

string

ID of a management contract to associate with this profile.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json