Create Franchise

HTTP Request

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

Example Response

{
"id": 0,
"site": 0,
"branches": [],
"created": "2021-09-08T10:31:30.244Z",
"modified": "2021-09-08T10:31:30.244Z",
"deleted": "2021-09-08T10:31:30.244Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"active": false,
"name": "string",
"franchisees": [],
"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",
"documents": [],
"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

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

active

boolean

Active

name

required

string[ 1...200 ] characters

Name

franchisees

nullable

array of integers

Franchisees

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

documents

nullable

array of integers

Documents

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

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