Available Methods

Create a 3D Tour

POST https://www.relahq.com/api/v1/object/virtual_tour

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

Request Body

Name	Type	Description
title*	String	The title of the object
property_reference*	String	The nid of the property this object is assigned to
branding*	String	"branded", "unbranded", "both", "hidden"
url*	String	The url to the 3D tour

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "nid": "9876",
}

Update a 3D Tour

PUT https://www.relahq.com/api/v1/object/virtual_tour/{nid}

Example request for updating branding.

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
content-type*	String	application/json
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token

Request Body

Name	Type	Description
branding*	String	"branded", "unbranded", "both", "hidden"

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    "nid": "9876",
}

Retrieve a 3D Tour

GET https://www.relahq.com/api/v1/object/virtual_tour/{nid}

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "nid": "9876",
  "title": "3D Tour Title String"
  "created": 1640432564
  "changed": 1640032456
  "property_reference": "1234", 
  "url": "https://my.matterport.com/show/?m=aSx1MpRRqif",
  "branding": "branded",
}

Delete a 3D Tour

DELETE https://www.relahq.com/api/v1/object/virtual_tour/{nid}

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    [true],
}