Skip to main content
← Resources
Developer Documentation

Franchise Promo API Reference

RESTful API documentation for integrating with Franchise Promo platform. Manage locations, campaigns, reporting, and integrations programmatically.

Base URL: api.franchisepromo.com/v1Format: JSON

Authentication

All API requests require Bearer token authentication. Tokens are scoped per franchise system and can be generated in the platform dashboard. Rate limiting applies at 1,000 requests per minute.

POST/v1/auth/tokenGenerate access token
POST/v1/auth/refreshRefresh expired token
DELETE/v1/auth/revokeRevoke active token

Locations

Manage franchise location data, including addresses, operating hours, attributes, and status. Location data powers local advertising, SEO, and reporting across the platform.

GET/v1/locationsList all locations
GET/v1/locations/:idGet location details
POST/v1/locationsCreate new location
PATCH/v1/locations/:idUpdate location
GET/v1/locations/:id/metricsLocation performance metrics

Campaigns

Create and manage advertising campaigns across channels. Supports Google Ads, Meta, TikTok, programmatic display, and CTV with location-level targeting and budget allocation.

GET/v1/campaignsList all campaigns
POST/v1/campaignsCreate campaign
GET/v1/campaigns/:id/performanceCampaign performance data
PATCH/v1/campaigns/:id/budgetUpdate campaign budget
POST/v1/campaigns/:id/pausePause campaign

Reporting

Access aggregated and per-location marketing performance data. Supports custom date ranges, channel breakdowns, and KPI rollups for system-level reporting.

GET/v1/reports/overviewSystem-level overview
GET/v1/reports/locations/:idPer-location report
GET/v1/reports/channelsChannel performance breakdown
POST/v1/reports/customGenerate custom report
GET/v1/reports/exportExport report as CSV/PDF

Webhooks

Subscribe to real-time events from the Franchise Promo platform. Webhooks support lead creation, campaign status changes, budget alerts, and performance threshold notifications.

GET/v1/webhooksList webhook subscriptions
POST/v1/webhooksCreate webhook subscription
DELETE/v1/webhooks/:idRemove webhook
POST/v1/webhooks/testSend test webhook event

Integrations

Connect with third-party platforms including CRMs (HubSpot, Salesforce), POS systems, franchise management platforms, and analytics tools.

GET/v1/integrationsList available integrations
POST/v1/integrations/:type/connectConnect integration
GET/v1/integrations/:type/statusCheck sync status
POST/v1/integrations/:type/syncTrigger manual sync

Ready to Build Your Integration?

Contact our developer relations team for API access, sandbox credentials, and integration support.

Request API Access