dashboard_create_franchisee

Create Franchisee

​

Allows a business admin user to create franchisees for accessible locations

Headers
  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".

Body
application/json
  • franchisee
    Type: object
Responses
  • 200
    Type: object

    The Franchisee object returns the details of the franchisee.

    • address
      Type: string

      Address of the franchisee

    • created_by
      Type: string

      Admin user who created the franchisee

    • email
      Type: string

      Email address of the franchisee

    • enable_guest_upload
      Type: boolean

      Whether to allow uploading a list of guests for the franchisee or not

    • name
      Type: string

      Name of the franchisee

    • phone
      Type: string

      Phone number of the franchisee

    • state
      Type: string

      State where the franchisee is located

    • zip_code
      Type: string

      Zip code where the franchisee is located

  • 401
    Type: object
    • error
      Type: string
post/api2/dashboard/franchisees
{
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "state": "string",
  "zip_code": "string",
  "created_by": "string",
  "enable_guest_upload": true
}