IGuideCreateInput

Parameters for creating a new iGUIDE. Required fields: type, industry, address.

addonsstring[]

Addon identifiers to enable (obsolete, use WorkOrderCreate to add addons to work orders)

address object

The iGUIDE address (required)

citystring

City name

countrystring

The two letter country code as defined by ISO 3166-2

postalCodestring

The postal code - or the local equivalent thereof - as defined by that country's post office.

provinceStatestring

The subdivision code as defined by ISO 3166-2

streetNamestring

Street name

streetNumberstring

Street number

unitNumberstring

The unit/apartment/suite number or other description of the property

applyDefaultsboolean

Enabling this field will apply user-defined presets in following order:

1. Apply the current iGUIDE Defaults of the operator.
2. Apply Banner Settings when a banner ID is provided in ViewParams

Example: true

defaultView object

Parameters for the Default View

bannerIdstring

A banner ID to be used for this iGUIDE

descriptionstring

A description of the property shown in the Details tab of the iGUIDE Viewer.

expiresAtstring

Expiration date in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format (max 10 years future, min 1 year past) Dates in the past will lock the iGUIDE view.

isProtectedboolean

If set to false, the View will be accessible publicly. Otherwise, the View will be accessible to the authenticated users appearing in the viewer list. The manager and editors always will have viewing access.

measStdstring

Measurement standard: "ansi" or "rms". If not explicitly set, the measurement standard will be set to the System Default (ANSI for US addresses, RMS otherwise).

viewersstring[]

A list of user IDs allowed to access the View when isProtected is set. The manager and editors always will have viewing access.

editorsstring[]

A list of user IDs to be added as editors to the created iGUIDE.

industrystring

Property Industry of iGUIDE to be created.

Possible values: [residential, commercial, irc, aec]

Example: residential

primaryContactstring<email>

A user ID to be assigned as the primary contact to the created iGUIDE.

reportSubscribersstring[]

A list of email addresses to be subscribed to the iGUIDE's report.

skipPrepublishboolean

This option is only applicable for draftable iGUIDE types such as standard or premium. When set to true, the iGUIDE will be published even if the Drafting team chooses to pre-publish it.

Example: false

typestring

Type of iGUIDE to be created.

Possible values: [standard, premium, radix, photos]

Example: standard

webhooks object[]

A list of webhooks to be added to the iGUIDE.

Array [

eventstring

Event type to subscribe to

urlstring

URL to receive webhook notifications

]

IGuideCreateInput

{
  "addons": [
    "string"
  ],
  "address": {
    "city": "string",
    "country": "string",
    "postalCode": "string",
    "provinceState": "string",
    "streetName": "string",
    "streetNumber": "string",
    "unitNumber": "string"
  },
  "applyDefaults": true,
  "defaultView": {
    "bannerId": "string",
    "description": "string",
    "expiresAt": "string",
    "isProtected": true,
    "measStd": "string",
    "viewers": [
      "string"
    ]
  },
  "editors": [
    "string"
  ],
  "industry": "residential",
  "primaryContact": "user@example.com",
  "reportSubscribers": [
    "string"
  ],
  "skipPrepublish": false,
  "type": "standard",
  "webhooks": [
    {
      "event": "string",
      "url": "string"
    }
  ]
}