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": [],
"meta": {},
"created": "2021-03-01T14:10:08.047Z",
"modified": "2021-03-01T14:10:08.047Z",
"deleted": "2021-03-01T14:10:08.047Z",
"source_ref": "string",
"eos3_id": -2147483648,
"display": false,
"active": false,
"uuid": "string",
"name": "string",
"branch_website": "string",
"country_code": "string",
"telephone_number": "string",
"fax_number": "string",
"email": "user@example.com",
"physical_address": "string",
"postal_address": "string",
"head_office": false,
"branch_profile": "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",
"blog_url": "http://www.example.com",
"pinterest_url": "http://www.example.com",
"google_my_business_url": "http://www.example.com",
"privy_seal_url": "http://www.example.com",
"privy_seal_image_url": "http://www.example.com",
"instagram_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,
"facebook_campaign_key": "string",
"adwords_campaign_key": "string",
"location": -2147483648,
"images": [],
"documents": [],
"serviced_locations": [],
"map_image": -2147483648,
"statistics": 0
}

NameDescription

id

integer

ID

site

integer

Site

archive_branch_action

object

portals

array

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

meta

string

Meta

created

string

Created

modified

string

Modified

deleted

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

name

required

string[ 1...200 ] characters

Name

branch_website

nullable

string<= 200 characters

Branch website

country_code

nullable

string<= 10 characters

Country code

telephone_number

required

string[ 1...40 ] characters

Telephone number

fax_number

string<= 40 characters

Fax 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

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

blog_url

string<= 100 characters

Blog url

pinterest_url

string<= 100 characters

Pinterest url

google_my_business_url

string<= 100 characters

Google my business url

privy_seal_url

string<= 100 characters

Privy seal url

privy_seal_image_url

string<= 100 characters

Privy seal image url

instagram_url

string<= 100 characters

Instagram 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

facebook_campaign_key

string<= 50 characters

Facebook campaign key

adwords_campaign_key

string<= 50 characters

Adwords campaign key

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_locations

nullable

array of integers

Serviced locations

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

map_image

nullable

integer

Map image

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