Create tour

This can only be done by the logged in user.

Body·
required
application/json

Created tour

  • matterId
    Type: string
    required

    Matterport id

  • title
    Type: string
    required

    Tour title

  • tourProvider
    Type: string enum
    required

    Tour provider. enum of 2 options - Matterport/Luma

    values
    • Matterport
    • Luma
  • internalAddress
    Type: string

    Tour internal address

  • userId
    Type: integer

    Tour user id

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/api/tours/create
curl https://api.treedis.com/v1/api/tours/create \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "userId": 1,
  "matterId": "",
  "title": "",
  "internalAddress": "",
  "tourProvider": "Matterport"
}'
{
  "status": 200,
  "message": "string",
  "timestamp": 1616146262053,
  "data": {
    "title": "Some title",
    "matterId": "EnFZzqza1QL",
    "status": "idle",
    "unitSystem": "metric",
    "assetPageType": "classic",
    "isSample": false,
    "textChatEnabled": false,
    "favoriteOfClient": false,
    "timezone": 2,
    "tourProvider": "Matterport",
    "lumaUrl": null,
    "lumaId": null,
    "internalAddress": "string",
    "clientId": null,
    "bookingAppointmentId": null,
    "mode": "regular",
    "slug": "some-title",
    "id": 3172,
    "minimap": false,
    "autoplayVideo": false,
    "panorama": false,
    "adLeads": true,
    "menuEnabled": false,
    "menuOnStart": false,
    "menuAlwaysOpenDesktop": false,
    "menuAlwaysOpenMobile": false,
    "screenshotEnabled": false,
    "disableContext": false,
    "music": false,
    "autoplayMusic": false,
    "hidePucks": false,
    "ad": false,
    "adWidth": 80,
    "adHeight": 60,
    "adWidthMobile": 80,
    "adHeightMobile": 60,
    "floorPlansEnabled": true,
    "customMinimap": false,
    "unbranded": false,
    "addon_title": 0,
    "addon_lang": "",
    "addon_brand": false,
    "addon_hl": 0,
    "addon_tourcta": 1,
    "addon_dh": true,
    "addon_mt": true,
    "addon_nozoom": true,
    "addon_pin": true,
    "addon_mls": 0,
    "addon_qs": false,
    "addon_gt": true,
    "addon_portal": true,
    "addon_f": true,
    "addon_wh": true,
    "addon_kb": true,
    "addon_lp": false,
    "addon_vr": true,
    "addon_ts": -1,
    "addon_help": -1,
    "addon_nt": false,
    "addon_search": false,
    "addon_hidetags": false,
    "showTitle": true,
    "paywall": false,
    "ticket": false,
    "tokenDuration": "-1",
    "contactForm": true,
    "fee": 0,
    "appointmentsOn": false,
    "appointmentTooltipOn": true,
    "enableAvatar": false,
    "imageInsteadOfAvatar": false,
    "getInTouchTooltipOn": true,
    "menuTooltipOn": true,
    "agentSelecting": true,
    "appointmentTime": 30,
    "share": true,
    "assetPageSocialSharing": true,
    "brightness": 1,
    "saturation": 1,
    "contrast": 1,
    "panoramaStart": false,
    "panoramaHd": true,
    "panoramaCompass": true,
    "hideMinimapHotspots": true,
    "enableBlackColorMenu": false,
    "allowGuestBeforeHost": true,
    "mpReel": true,
    "mpPlay": true,
    "noAudioMode": false,
    "multilingual": false,
    "menuSearch": false,
    "hideCookie": false,
    "gameId": null,
    "hideClientContact": false,
    "enableVS": false,
    "htmlActive": false,
    "panoramaTransition": false,
    "showNavTools": false,
    "stopAfterSweep": null,
    "rotationAngle": null,
    "rotationSpeed": null,
    "vsRenderRange": null,
    "vsAnimationDistance": 5,
    "transitionSpeed": null,
    "showNavPath": false,
    "walkNav": false,
    "teleportNav": false,
    "autoNav": false,
    "minimapVisible": true,
    "customButton": false,
    "patchIconEnabled": false,
    "menuCategoryExpand": false,
    "archived": false,
    "favorite": false,
    "ecommercePaidStatus": false,
    "tagsActive": true,
    "isPublic": true,
    "isWalkieTalkieOn": false,
    "musicControl": true,
    "freeExperience": false,
    "freeAR": false,
    "freeTicketing": false,
    "freeVCommerce": false,
    "freeAvatar": false,
    "storeEnabled": true,
    "hideSidebarConfigs": false,
    "hideSoundControls": false,
    "hideLanguageSelect": false,
    "hideSubtitlesSelect": false,
    "hideMPTagDock": true,
    "hideMPTagSwitcher": false,
    "mpTagDockSide": "right",
    "callIconEnabled": false,
    "addressIconEnabled": false,
    "ss": null,
    "sr": null,
    "background": null,
    "backgroundImage": null,
    "tourMusicName": null,
    "ar": false,
    "cookieIsMandatory": false,
    "loadTourAfterCookie": false,
    "isThreadsEnabled": false,
    "charset": "utf-8",
    "navigationWebEnabled": false,
    "navigationAREnabled": false,
    "pme": false,
    "allowedDomains": [
      "example.com",
      "mydomain.com",
      "anotherdomain.org"
    ],
    "iot2FAEnabled": true,
    "updatedAt": "2024-08-07T14:09:24.332Z",
    "password": null,
    "analyticsPassword": null,
    "address": null,
    "mainImage": null,
    "scannedAt": null,
    "size": null,
    "enableIot": false,
    "beds": null,
    "cars": null,
    "showers": null,
    "price": null,
    "assetDescription": null,
    "accomodation": null,
    "vrUrl": null,
    "summary": null,
    "audioVolume": 1,
    "bookUrl": null,
    "bookColor": null,
    "bookText": null,
    "exploreText": null,
    "adTime": null,
    "adUrl": null,
    "adRes": "percentage",
    "adResMobile": "percentage",
    "droneUrl": null,
    "videoUrl": null,
    "sameMusicForAllFloors": false,
    "messengerLink": null,
    "messengerGreeting": null,
    "error": null,
    "parentId": null,
    "subscriptionStart": null,
    "subscriptionId": null,
    "description": null,
    "collectLeads": false,
    "leadsComment": null,
    "leadsEmail": true,
    "leadsPhone": true,
    "leadsTimedPhone": true,
    "leadsTimedName": true,
    "leadsTimedEmail": true,
    "reel": null,
    "legalNote": null,
    "legalBookingBox": null,
    "legalBookingBox2": null,
    "registrationBackground": "",
    "termsUrl": null,
    "languageId": null,
    "htmlDescription": null,
    "htmlCode": null,
    "vsPaymentId": null,
    "subTitle": null,
    "videoWidth": null,
    "videoHeight": null,
    "customButtonIcon": null,
    "patchIcon": null,
    "customButtonUrl": null,
    "customButtonOpenAs": "tab",
    "industry": null,
    "ecommerceSubscriptionId": null,
    "fontFamily": null,
    "termsAndConditions": null,
    "createdAt": "2024-08-07T14:09:24.332Z",
    "clientFolderId": null,
    "folderId": null
  }
}