For AI agents: visit https://docs.shoutaboutus.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference

API Reference

Guides API Reference

Authentication
Create and manage accounts
Add and manage locations
Plans and entitlements
Account plan view
Move locations between plan tiers

Review site catalogue
Connect review sites
Google Business Profile
Facebook
Webhooks
Error notifications

Respond to reviews
AI assistance
- Generate AI response
- List successful AI responses for a review

AI insight report
Competitive report

Campaigns
Send a review request
Recipients
- Upload audience
- List recipients
Email templates
SMS templates
Landing page templates
QR codes
QR code templates
Automated campaigns
Request usage and overage
- Email overage summary
- SMS overage summary

Flag a review for removal

Review widget
FAQ and testimonials
Images
Widgets
Branding and white label
White-label emails
Hosted landing page

Partner
Account

Users and roles (partner)
Users and profile (account)
Act as an account owner
- Mint account-owner token
Billing address and checkout
Single sign-on
Public self-service signup
Reference data
Google connection activity
- Industries dropdown
- Connection feed + KPIs
Referral programme
- Track click
- Get referral info
Campaign public links & tracking
QR public scan tracking
- Public scan tracking

Powered by

Widgets and display (optional)

Widgets

List, create/update and delete display widgets for an account.

List, create/update and delete display widgets for an account.

Updated about 8 hours ago

Did this page help you?

Updated about 8 hours ago

Did this page help you?