Available Methods

Create a Property Video

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

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"
video_url*	String	An accessible Youtube/Vimeo url OR a publicly accessible url to an MP4 or MOV file.
make_cover_video	Bool	Whether this video should be a cover video

200: OK Success

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

Update a Property Video

PUT https://www.relahq.com/api/v1/object/property_video/{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 Property Video

GET https://www.relahq.com/api/v1/object/property_video/{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

Request Body

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

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "nid": "9876",
  "title": "Video Title String"
  "created": 1640432564
  "changed": 1640032456
  "property_reference": "1234", 
  "video_url": "https://www.youtube.com/watch?v=234234502NRk",
  "branding": "branded",
  "make_cover_video": FALSE,
}

Delete a Property Video

DELETE https://www.relahq.com/api/v1/object/property_video/{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],
}