Skip to content

create-announcement.md

Latest commit

 

History

History
152 lines (96 loc) · 2.77 KB

create-announcement.md

File metadata and controls

152 lines (96 loc) · 2.77 KB
Raw

📢 How to Create Announcements

You can create announcements in two ways:

  1. 🖥️ From Connect Pi Dashboard (Manual)
  2. ⚡ Using API (Recommended for automation)

🖥️ Method 1: Create from Dashboard

You can directly create announcements from your app dashboard.

📍 Step 1: Open Your App

Go to your app dashboard after creating your app.

✍️ Step 2: Create Announcement

  • Click on Create Announcement
  • Write your update message
  • Submit the announcement

Create Announcement

📤 Step 3: Publish

Once submitted:

  • Announcement is instantly published
  • Visible to all your app users

Announcement Form

🎯 When to Use This?

  • Quick updates
  • Manual announcements
  • Small apps without backend

⚡ Method 2: Create via API

You can automate announcements using API from your admin panel or backend.

🚀 API Endpoint

POST https://www.connectpi.in/api/apphub/announcements

🧾 Example (cURL)

curl -X POST https://www.connectpi.in/api/apphub/announcements \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"content": "Version 2.0 is now live for everyone!"}'

💡 How It Works

  • Your API key automatically identifies your app
  • No need to send App ID manually
  • Announcement is instantly broadcasted

🛠️ Use in Your Admin Panel

You can integrate this API into your admin panel:

  • Add a form (title + content)
  • Send POST request from backend
  • Publish announcements directly

👉 This allows:

  • Fully automated updates
  • Scheduled announcements
  • CMS-style control

✨ Content Formatting

Announcements support rich formatting (Max: 1000 characters)

Style Syntax
Bold **text**
Italic *text*
Underline __text__
Strikethrough ~~text~~
Red [color:red](text)
Blue [color:blue](text)
Green [color:green](text)

⚠️ Error Troubleshooting

❌ 401 Unauthorized

  • API key missing
  • Invalid key
  • Revoked key

❌ 400 Bad Request

  • Invalid JSON format
  • content field missing

❌ 404 Not Found

  • App deleted
  • Developer account removed

🎯 You're Ready!

Now you can:

  • 📢 Send announcements instantly
  • ⚡ Automate updates from backend
  • 🚀 Keep users engaged

💡 Pro Tip

Use API-based announcements to:

  • Send updates after deployments
  • Notify users about new features
  • Trigger announcements from events