Create Franchise

HTTP Request

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

Example Response

{
"id": 0,
"site": 0,
"branches": [],
"created": "2024-03-28T13:31:09.235Z",
"modified": "2024-03-28T13:31:09.235Z",
"deleted": "2024-03-28T13:31:09.235Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"active": false,
"name": "string",
"legal_name": "string",
"franchisees": [],
"directors": [],
"principals": [],
"country_code": "string",
"telephone_number": "string",
"fax_number": "string",
"email": "user@example.com",
"physical_address": "string",
"postal_address": "string",
"location": -2147483648,
"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",
"instagram_url": "http://www.example.com",
"serviced_listing_types": [],
"serviced_business_types": [],
"gross_commission": -2147483648,
"franchise_fee_payable": false,
"stakeholder_company_registration_number": "string",
"stakeholder_vat_registration_number": "string",
"stakeholder_fidelity_fund_number": "string",
"stakeholder_bank_name": "string",
"stakeholder_bank_account_number": "string",
"stakeholder_bank_branch_code": "string",
"target_type": "string",
"number_of_people_canvassed": -2147483648,
"number_of_valuations": -2147483648,
"mandates_created": -2147483648,
"sole_mandates_created": -2147483648,
"property_matches_sent": -2147483648,
"viewings": -2147483648,
"show_houses": -2147483648,
"feedback_requests_sent": -2147483648,
"listings_sold": -2147483648,
"listings_created": -2147483648,
"listings_sold_value": "0.00",
"number_of_agents": -2147483648,
"awards": null,
"documents": [],
"search_vector": "string",
"statistics": 0,
"division": [],
"region": []
}

NameDescription

id

integer

ID

site

integer

Site

branches

required

array of integers

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

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

active

boolean

Active

name

required

string[ 1...200 ] characters

Name

legal_name

nullable

string<= 200 characters

Legal name

franchisees

nullable

array of integers

Franchisees

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

directors

nullable

array of integers

Directors

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

principals

nullable

array of integers

Principals

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

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

location

nullable

integer

Location

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

instagram_url

string<= 100 characters

Instagram url

serviced_listing_types

nullable

array of strings

Serviced listing types

Choices: ResidentialResidential New DevelopmentResidential EstateCommercialCommercial New DevelopmentCommercial EstateIndustrialRetailAgriculturalMixed UseHoliday Letting

serviced_business_types

nullable

array of strings

Serviced business types

Choices: To LetFor SaleAuction

gross_commission

nullable

integer

Gross commission

franchise_fee_payable

boolean

Franchise fee payable

stakeholder_company_registration_number

nullable

string<= 100 characters

Stakeholder company registration number

stakeholder_vat_registration_number

nullable

string<= 100 characters

Stakeholder vat registration number

stakeholder_fidelity_fund_number

nullable

string<= 30 characters

Stakeholder fidelity fund number

stakeholder_bank_name

nullable

string<= 100 characters

Stakeholder bank name

stakeholder_bank_account_number

nullable

string<= 80 characters

Stakeholder bank account number

stakeholder_bank_branch_code

nullable

string<= 30 characters

Stakeholder bank branch code

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

sole_mandates_created

nullable

integer

Sole mandates created

property_matches_sent

nullable

integer

Property matches sent

viewings

nullable

integer

Viewings

show_houses

nullable

integer

Show houses

feedback_requests_sent

nullable

integer

Feedback requests sent

listings_sold

nullable

integer

Listings sold

listings_created

nullable

integer

Listings created

listings_sold_value

nullable

string

Listings sold value

number_of_agents

nullable

integer

Number of agents

awards

nullable

object

Awards

documents

nullable

array of integers

Documents

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

search_vector

nullable

string

Search vector

statistics

nullable

integer

Statistics

division

required

array of integers

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

region

required

array of integers

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

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