Propertyware · Schema

Campaign

Property ManagementReal EstateRental PropertiesSingle-Family RentalsLeasesTenantsMaintenanceWork OrdersFinancial TransactionsOwner Reports

Properties

Name	Type	Description
acceptedCallTrackingTerms	boolean	Indicates if the call tracking terms have been accepted.
callTrackingCampaignID	string	Campaign ID used for call tracking.
callTrackingEnabled	boolean	Indicates if call tracking is enabled for the campaign.
callTrackingForwar	string	Number to which call tracking calls are forwarded.
callTrackingForwarAfterHours	string	Number to which call tracking calls are forwarded after hours.
callTrackingPhoneNumber	string	Phone number used for call tracking.
callTrackingReferrer	string	Referrer for call tracking.
callTrackingSearchPhrase	string	Search phrase for call tracking.
campaignSource	object
code	string	Code of the campaign.
createdBy	string	User who created the record.
createdDateTime	string	Date and time the record was created. (Timezone: UTC)
customFields	array	Custom fields.
description	string	Description of the campaign.
endDate	string	End date of the campaign.
id	integer	Unique identifier.
lastModifiedBy	string	User who last modified the record.
lastModifiedDateTime	string	Date and time the record was last modified. (Timezone: UTC)
name	string	Name of the campaign.
startDate	string	Start date of the campaign.
targetProspectType	string	Type of the targeted prospect.
timezone	string	Time zone of the campaign.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Campaign",
  "description": "Campaign",
  "type": "object",
  "properties": {
    "acceptedCallTrackingTerms": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the call tracking terms have been accepted."
    },
    "callTrackingCampaignID": {
      "type": "string",
      "description": "Campaign ID used for call tracking."
    },
    "callTrackingEnabled": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if call tracking is enabled for the campaign."
    },
    "callTrackingForwar": {
      "type": "string",
      "description": "Number to which call tracking calls are forwarded."
    },
    "callTrackingForwarAfterHours": {
      "type": "string",
      "description": "Number to which call tracking calls are forwarded after hours."
    },
    "callTrackingPhoneNumber": {
      "type": "string",
      "description": "Phone number used for call tracking."
    },
    "callTrackingReferrer": {
      "type": "string",
      "description": "Referrer for call tracking."
    },
    "callTrackingSearchPhrase": {
      "type": "string",
      "description": "Search phrase for call tracking."
    },
    "campaignSource": {
      "$ref": "#/components/schemas/CampaignSource"
    },
    "code": {
      "type": "string",
      "description": "Code of the campaign."
    },
    "createdBy": {
      "type": "string",
      "description": "User who created the record."
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the record was created. (Timezone: UTC)"
    },
    "customFields": {
      "type": "array",
      "description": "Custom fields.",
      "items": {
        "$ref": "#/components/schemas/CustomField"
      }
    },
    "description": {
      "type": "string",
      "description": "Description of the campaign."
    },
    "endDate": {
      "type": "string",
      "format": "date",
      "description": "End date of the campaign."
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier."
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "User who last modified the record."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the record was last modified. (Timezone: UTC)"
    },
    "name": {
      "type": "string",
      "description": "Name of the campaign."
    },
    "startDate": {
      "type": "string",
      "format": "date",
      "description": "Start date of the campaign."
    },
    "targetProspectType": {
      "type": "string",
      "description": "Type of the targeted prospect."
    },
    "timezone": {
      "type": "string",
      "description": "Time zone of the campaign."
    }
  }
}