The Portfolio object

idstringrequired

typestringrequired

Possible values: [portfolios]

attributes required

namestring

The portfolio's name

metadataobject

Additional metadata for the portfolio

Example: {"field_1":"value1","field_2":"value2"}

created_atdate-time

updated_atdate-time

client_account_idstring

management_organisation_idstring

client_organisation_idstring

join_logo_urlstring

join_emailstring

join_namestring

join_primary_colorstring

join_background_colorstring

management_logo_urlstring

before_stay_maintenance_providerstring

during_stay_maintenance_providerstring

third_party_maintenance_issues_enabled_atdate-time

refund_holding_deposit_setboolean

partner_generates_contracts_enabledboolean

partner_issues_contracts_enabledboolean

agent_chooses_who_collects_holding_deposit_enabledboolean

agent_can_set_holding_deposit_amount_enabledboolean

residently_move_enabledboolean

find_logo_urlstring

find_emailstring

find_contact_numberstring

find_partner_external_namestring

find_primary_colorstring

find_background_colorstring

app_primary_colorstring

app_dashboard_colorstring

app_logo_urlstring

app_logo_widthinteger

pms_data_sync_enabled_atdate-time

pms_data_sync_provider_idsstring[]

The Portfolio object

{
  "id": "string",
  "type": "portfolios",
  "attributes": {
    "name": "string",
    "metadata": {
      "field_1": "value1",
      "field_2": "value2"
    },
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "client_account_id": "string",
    "management_organisation_id": "string",
    "client_organisation_id": "string",
    "join_logo_url": "string",
    "join_email": "string",
    "join_name": "string",
    "join_primary_color": "string",
    "join_background_color": "string",
    "management_logo_url": "string",
    "before_stay_maintenance_provider": "string",
    "during_stay_maintenance_provider": "string",
    "third_party_maintenance_issues_enabled_at": "2024-07-29T15:51:28.071Z",
    "refund_holding_deposit_set": true,
    "partner_generates_contracts_enabled": true,
    "partner_issues_contracts_enabled": true,
    "agent_chooses_who_collects_holding_deposit_enabled": true,
    "agent_can_set_holding_deposit_amount_enabled": true,
    "residently_move_enabled": true,
    "find_logo_url": "string",
    "find_email": "string",
    "find_contact_number": "string",
    "find_partner_external_name": "string",
    "find_primary_color": "string",
    "find_background_color": "string",
    "app_primary_color": "string",
    "app_dashboard_color": "string",
    "app_logo_url": "string",
    "app_logo_width": 0,
    "pms_data_sync_enabled_at": "2024-07-29T15:51:28.071Z",
    "pms_data_sync_provider_ids": [
      "string"
    ]
  }
}