Skip to main content

Franchise model

A Franchise represents a branded grouping that can be associated with a business and presentation metadata. A Franchise is distinct from an Importer.

Operations​

ActionMethodResource
ListGET/franchises
FindGET/franchises/{franchise_id}
CreatePOST/franchises
UpdatePOST/franchises/{franchise_id}
DeleteDELETE/franchises/{franchise_id}

List and item reads may be public. Creating, updating, or deleting a franchise may require super-administrator access; read permissions do not imply mutation access.

Representative model fields include id, name, internal_name, slug, logo, description, header, enabled, business_id, country_phone_code, cellphone, phone, timezone, and site_id. Relations include business and ribbon.