iGUIDE Create Params
Create iGUIDE page allows passing external values to the page to initialize various attributes for newly created iGUIDEs. This will reduce or eliminate manual data entry in cases where the customer order forms collect information used to create a new iGUIDE.
Support Parameters
The parameters listed here are optional. You can provide all, some or none of them.
industry
A string indicating the Property Industry of iGUIDE to be created; more details.
Accepted Values
residential- Residential Real Estate iGUIDEcommercial- Commercial Real Estate iGUIDEirc- Insurance & Restoration iGUIDEaec- Architecture, Engineering & Construction iGUIDE
Example:
https://manage.youriguide.com/iguides/new?industry=irc
packageType
A string indicating the type of iGUIDE to be created.
Accepted Values
standard- Standard iGUIDE, https://goiguide.com/processing-pricingpremium- Premium iGUIDE, https://goiguide.com/processing-pricingradix- Radix iGUIDE, https://goiguide.com/processing-pricing and https://goiguide.com/insurance-restorationphotos- Photos-only iGUIDE, https://goiguide.com/iguide-photos
WARNING
Omitting the parameter or passing an empty or unrecognized string as the value will result in the creation of a standard iGUIDE.
Example:
https://manage.youriguide.com/iguides/new?packageType=premium
packageAddons
A comma separated list of paid addons to be purchased for the iGUIDE upon creation.
WARNING
Available addons may vary depending on account settings.
Accepted values
vr- iGUIDE VR add-on (included in Premium iGUIDE), https://goiguide.com/vradvmeas- Advanced Measurement add-on (included in Premium iGUIDE), https://goiguide.com/advanced-measurementfloorplanner- Floorplanner add-on, https://goiguide.com/floorplannerstreetview- Google Street View add-on, https://goiguide.com/google-street-viewesx- Xactimate ESX add-on, https://goiguide.com/esx
Example
https://manage.youriguide.com/iguides/new?packageAddons=streetview
country
A string containing a two letter country code as defined by ISO 3166-2.
Example
https://manage.youriguide.com/iguides/new?country=CA
provinceState
A string containing a subdivision code as defined by ISO 3166-2.
WARNING
While the parameter references a province or state, it actually applies to whatever subdivision type is used in the country the property is located in, be it province, state, territory, region, or other.
Accepted values
A subdivision code that is valid for the country defined in country. There are too many possibilities to list here.
Example
https://manage.youriguide.com/iguides/new?country=CA&provinceState=ON
city
A string containing the city the property is located in.
Accepted values
A URL encoded string.
Example
https://manage.youriguide.com/iguides/new?country=CA&provinceState=ON&city=Kitchener
postalCode
A string containing the postal code - or the local equivalent thereof - as defined by that country’s post office.
Accepted values
Varies by location. See the country’s post office regulations for more details.
Example
streetName
A string containing the property’s street name.
Accepted values
A URL encoded string.
Example
streetNumber
A string containing the property’s street number.
WARNING
The street number may vary depending on the country and may be a combination of digits, letters and special symbols.
Accepted values
A URL encoded string.
Example
unitNum
A string containing the unit/apartment/suite number or other description of the property.
WARNING
This is where any additional unit descriptors like, “basement” or “penthouse” would go.
Accepted values
A URL encoded string.
Example
searchAddress
A string containing the full address of the property excluding postal code and unit number. When this parameter is set and none of the address parameters above are set, we perform a Google Places Search and fill the form with the result.
WARNING
This parameter is ignored if it is used with other address parameters such as city, country etc.
Accepted values
A URL encoded string.
Example
https://manage.youriguide.com/iguides/new?searchAddress=301+King+St+E+Kitchener+ON+CA
bannerName
The name of the agent whose banner should be inserted into the iGUIDE for branding purposes.
WARNING
The name is used to search both the operator’s account and any other associated user accounts in the system to try to find a matching banner. If the agent’s name does not return any results then no banner will be selected unless there is also a banner email specified that does return results.
Accepted values
A URL encoded string.
Example
https://manage.youriguide.com/iguides/new?bannerName=guy+m+anderson
bannerEmails
The email addresses from the banner that should be inserted into the iGUIDE for branding purposes.
WARNING
The emails are used to search both the operator’s account and any other associated user accounts in the system to try to find a matching banner. If the emails do not return any results then no banner will be selected unless there is also a banner name specified that does return results.
Accepted values
A comma separated list of email addresses.
Example
https://manage.youriguide.com/iguides/new?bannerEmails=user1@example.com,user2@example.com
reportSubscribers
A string containing the email addresses to be subscribed to the iGUIDE’s report.
WARNING
The email addresses do not need to belong to users with existing accounts on the portal in order to be subscribed to the iGUIDE report.
Accepted values
A comma separated list of email addresses.
Example
https://manage.youriguide.com/iguides/new?reportSubscribers=user1@example.com,user2@example.com
editors
A string containing the email addresses of the users to be made editors of the iGUIDE.
WARNING
The email addresses must belong to users with existing accounts on the portal in order to be added as editors to the iGUIDE. Email addresses that don’t match any user account will be ignored.
Accepted values
A comma separated list of email addresses
Example
https://manage.youriguide.com/iguides/new?editors=user1@example.com,user2@example.com
analyticSubscribers
A string containing the email addresses to be subscribed to the iGUIDE’s analytics.
WARNING
The email addresses do not need to belong to users with existing accounts on the portal in order to be subscribed to the iGUIDE report.
Accepted values
A comma separated list of email addresses.
Example
https://manage.youriguide.com/iguides/new?analyticSubscribers=user1@example.com,user2@example.com
videoBranded
A string containing the URL to the external video to be embedded in the branded iGUIDE.
Supported video services:
Supported file hosts:
To embed a video from a supported file host, the video file must be of mp4, webm or ogv format.
For OneDrive you must input the source URL from the embed code, NOT the share link.
Directly linking to a hosted video file is also supported. The file extension (mp4, webm or ogv) must be included in the URL.
Accepted values
A URL encoded URL from a video hosting service.
Example
https://manage.youriguide.com/iguides/new?videoBranded=https:%2F%2Fyoutu.be%2FdQw4w9WgXcQ
videoUnbranded
A string containing the URL to the external video to be embedded in the unbranded iGUIDE.
Supported video services:
Supported file hosts:
To embed a video from a supported file host, the video file must be of mp4, webm or ogv format.
For OneDrive you must input the source URL from the embed code, NOT the share link.
Directly linking to a hosted video file is also supported. The file extension (mp4, webm or ogv) must be included in the URL.
Accepted values
A URL encoded URL from a video hosting service.
Example
https://manage.youriguide.com/iguides/new?videoUnbranded=https:%2F%2Fyoutu.be%2FdQw4w9WgXcQ
webhooks
A string containing the URLs for the webhooks to be added to the iGUIDE.
Accepted values
A comma separated list of URL encoded URLs.
WARNING
If there is a particular string identifier that should be returned as part of a webhook call then it should be specified as a URL encoded query string parameter as part of the webhook.
Example
https://manage.youriguide.com/iguides/new?webhooks=https:%2F%2Fgoiguide.com%2F