Create Branch

HTTP Request

POSThttps://staging.api-gw.propdata.net/branches/api/v1/branches/

Example Response

{
"id": 0,
"site": 0,
"archive_branch_action": {
"action": "string",
"assign_to_branch": 0
},
"portals": [],
"review_providers": [],
"testimonials": [],
"meta": {},
"created": "2024-03-28T13:31:08.779Z",
"modified": "2024-03-28T13:31:08.779Z",
"deleted": "2024-03-28T13:31:08.779Z",
"source_ref": "string",
"eos3_id": -2147483648,
"display": false,
"active": false,
"uuid": "string",
"lightstone_api_key": "string",
"openai_api_key": "string",
"name": "string",
"country_code": "string",
"telephone_number": "string",
"fax_number": "string",
"cell_number": "string",
"email": "user@example.com",
"physical_address": "string",
"postal_address": "string",
"head_office": false,
"branch_profile": "string",
"blog_url": "http://www.example.com",
"website_url": "string",
"facebook_url": "http://www.example.com",
"twitter_url": "http://www.example.com",
"linkedin_url": "http://www.example.com",
"youtube_url": "http://www.example.com",
"pinterest_url": "http://www.example.com",
"google_my_business_url": "http://www.example.com",
"ooba_obi_tracking_code": "string",
"instagram_url": "http://www.example.com",
"vimeo_url": "http://www.example.com",
"map_x_position": "string",
"map_y_position": "string",
"facebook_app_id": "string",
"facebook_app_secret": "string",
"facebook_profile_id": "string",
"fb_oauth_access_token": "string",
"fb_page_token": "string",
"feed_facebook_listings": false,
"feed_facebook_news": false,
"branch_managers": [],
"branch_franchisees": [],
"agent_of_the_month": -2147483648,
"leads_manager": -2147483648,
"referrals_managers": [],
"distressed_sales_coordinator": -2147483648,
"facebook_tracking_keys": [],
"adwords_tracking_keys": [],
"location": -2147483648,
"images": [],
"documents": [],
"serviced_suburbs": [],
"serviced_areas": [],
"serviced_listing_types": [],
"map_image": -2147483648,
"awards": null,
"facebook_verification_key": "string",
"linkedin_tracking_keys": [],
"target_type": "string",
"number_of_people_canvassed": -2147483648,
"number_of_valuations": -2147483648,
"mandates_created": -2147483648,
"listings_sold": -2147483648,
"listings_created": -2147483648,
"listings_sold_value": "0.00",
"google_business_account_id": "string",
"referral_intra_branch": false,
"statistics": 0
}

NameDescription

id

integer

ID

site

integer

Site

archive_branch_action

object

portals

array of integers

Choices: [ 1,2,3...2147483648 ]

review_providers

array of integers

Choices: [ 1,2,3...2147483648 ]

testimonials

array of integers

Choices: [ 1,2,3...2147483648 ]

meta

string

Meta

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

source_ref

nullable

string<= 100 characters

Source ref

eos3_id

nullable

integer

Eos3 id

display

boolean

Display

active

boolean

Active

uuid

string[ 1...36 ] characters

Uuid

lightstone_api_key

nullable

string<= 50 characters

Lightstone api key

openai_api_key

nullable

string<= 100 characters

Openai api key

name

required

string[ 1...200 ] characters

Name

country_code

nullable

string<= 10 characters

Country code

telephone_number

required

string[ 1...40 ] characters

Telephone number

fax_number

string<= 40 characters

Fax number

cell_number

string<= 40 characters

Cell number

email

required

string[ 1...254 ] characters

Email

physical_address

required

stringnon-empty

Physical address

postal_address

required

stringnon-empty

Postal address

head_office

boolean

Head office

branch_profile

nullable

string

Branch profile

blog_url

string<= 100 characters

Blog url

website_url

nullable

string<= 200 characters

Website url

facebook_url

string<= 100 characters

Facebook url

twitter_url

string<= 100 characters

Twitter url

linkedin_url

string<= 100 characters

Linkedin url

youtube_url

string<= 100 characters

Youtube url

pinterest_url

string<= 100 characters

Pinterest url

google_my_business_url

string<= 100 characters

Google my business url

ooba_obi_tracking_code

string<= 100 characters

Ooba obi tracking code

instagram_url

string<= 100 characters

Instagram url

vimeo_url

string<= 100 characters

Vimeo url

map_x_position

string<= 50 characters

Map x position

map_y_position

string<= 50 characters

Map y position

facebook_app_id

nullable

string<= 50 characters

Facebook app id

facebook_app_secret

string<= 50 characters

Facebook app secret

facebook_profile_id

string<= 50 characters

Facebook profile id

fb_oauth_access_token

nullable

string

Fb oauth access token

fb_page_token

nullable

string

Fb page token

feed_facebook_listings

boolean

Feed facebook listings

feed_facebook_news

boolean

Feed facebook news

branch_managers

nullable

array of integers

Branch managers

Choices: [ 1,2,3...2147483648 ]

branch_franchisees

nullable

array of integers

Branch franchisees

Choices: [ 1,2,3...2147483648 ]

agent_of_the_month

nullable

integer

Agent of the month

leads_manager

nullable

integer

Leads manager

referrals_managers

nullable

array of integers

Referrals managers

Choices: [ 1,2,3...2147483648 ]

distressed_sales_coordinator

nullable

integer

Distressed sales coordinator

facebook_tracking_keys

nullable

array of strings

Facebook tracking keys

Choices: [ 1,2,3...2147483648 ]

adwords_tracking_keys

nullable

array of strings

Adwords tracking keys

Choices: [ 1,2,3...2147483648 ]

location

nullable

integer

Location

images

nullable

array of integers

Images

Choices: [ 1,2,3...2147483648 ]

documents

nullable

array of integers

Documents

Choices: [ 1,2,3...2147483648 ]

serviced_suburbs

nullable

array of integers

Serviced suburbs

Choices: [ 1,2,3...2147483648 ]

serviced_areas

nullable

array of integers

Serviced areas

Choices: [ 1,2,3...2147483648 ]

serviced_listing_types

nullable

array of strings

Serviced listing types

Choices: For SaleTo Let

map_image

nullable

integer

Map image

awards

nullable

object

Awards

facebook_verification_key

nullable

string<= 50 characters

Facebook verification key

linkedin_tracking_keys

nullable

array of strings

Linkedin tracking keys

Choices: [ 1,2,3...2147483648 ]

target_type

nullable

string

Target type

Choices: MonthlyQuarterlyYearly

number_of_people_canvassed

nullable

integer

Number of people canvassed

number_of_valuations

nullable

integer

Number of valuations

mandates_created

nullable

integer

Mandates created

listings_sold

nullable

integer

Listings sold

listings_created

nullable

integer

Listings created

listings_sold_value

nullable

string

Listings sold value

google_business_account_id

nullable

string<= 30 characters

Google business account id

referral_intra_branch

boolean

Referral intra branch

statistics

nullable

integer

Statistics

Responses

201
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active