Create Franchisee Company

Create a new franchisee (reporting) company under your franchisor (managing) company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a new franchisee company in your brand-wide hierarchy, plus its first user with the Owner permission level. The new company inherits its brand, industry, logo, time zone, and temperature unit from your company. Your brand's projects and forms are copied to it in the background.

🔑

Save the franchisee's API token!

The response contains the new owner's API token at data.owner.userprofile.api_token. This is the only time the API returns it. Use this token for every call that builds the franchisee's hierarchy (teams, users, locations). If you use your own franchisor token for those calls, they either fail or create records in the wrong company.

🚧

Permissions

The X-API-TOKEN must belong to a user with the Owner permission level in the franchisor company.

Body Params
string
required

Franchisee company name

string

Company phone number. It is normalized; an invalid number returns a 400.

string

A value to identify this franchisee in your system.

owner
object
required

The franchisee's first user, created with the Owner permission level.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json