Growth Domain - Bruno API Collection

Complete Bruno collection for the Growth domain API endpoints.

📁 Collection StructureCopy Anchor Link

Growth/
├── environments/
│   ├── local.bru           # Local development environment
│   └── staging.bru         # Staging environment
├── Campaigns/              # Campaign management endpoints (11 files)
├── Campaign Messages/       # Campaign message templates (6 files)
├── Leads/                   # Lead management endpoints (9 files)
│   └── Lead Activities/     # Lead audit trail (1 file)
├── Patient Segments/        # Patient segmentation endpoints (9 files)
├── Communications/          # Communication tracking endpoints (3 files)
├── Review Requests/         # Review management endpoints (4 files)
└── README.md               # This file

🚀 Setup InstructionsCopy Anchor Link

1. Install BrunoCopy Anchor Link

Download and install Bruno from: https://www.usebruno.com/downloads

2. Import CollectionCopy Anchor Link

1. Open Bruno
2. Click "Import Collection"
3. Select the Growth/ folder
4. Choose your environment (local or staging)

3. Configure Environment VariablesCopy Anchor Link

Edit the environment file and update:

• url: Your API base URL
• access_token: Your authentication token
• campaign_id, lead_id, etc.: Sample resource IDs for testing

🔑 AuthenticationCopy Anchor Link

All endpoints use Bearer token authentication. Set your token in the environment variables:

vars {
  access_token: eyJhbGciOiJIUzI1NiJ9...
}

📊 API Endpoints SummaryCopy Anchor Link

Campaigns (11 endpoints)Copy Anchor Link

• GET /growth/campaigns - List all campaigns
• POST /growth/campaigns - Create new campaign
• GET /growth/campaigns/:id - Show campaign details
• PATCH /growth/campaigns/:id - Update campaign
• DELETE /growth/campaigns/:id - Delete draft campaign
• POST /growth/campaigns/:id/schedule - Schedule campaign
• POST /growth/campaigns/:id/start - Start campaign execution
• POST /growth/campaigns/:id/pause - Pause running campaign
• POST /growth/campaigns/:id/complete - Complete campaign
• POST /growth/campaigns/:id/cancel - Cancel campaign
• GET /growth/campaigns/:id/metrics - Get campaign metrics

Campaign Messages (6 endpoints)Copy Anchor Link

• GET /growth/campaigns/:campaign_id/messages - List campaign messages
• POST /growth/campaigns/:campaign_id/messages - Create message template
• GET /growth/campaigns/:campaign_id/messages/:id - Show message
• PATCH /growth/campaigns/:campaign_id/messages/:id - Update message
• DELETE /growth/campaigns/:campaign_id/messages/:id - Delete message
• GET /growth/campaigns/:campaign_id/messages/:id/preview - Preview rendered message

Leads (9 endpoints)Copy Anchor Link

• GET /growth/leads - List all leads
• POST /growth/leads - Create new lead
• GET /growth/leads/:id - Show lead details
• PATCH /growth/leads/:id - Update lead
• DELETE /growth/leads/:id - Delete lead
• POST /growth/leads/:id/convert - Convert lead to patient
• POST /growth/leads/:id/assign - Assign lead to user
• POST /growth/leads/bulk_import - Bulk import leads from CSV
• GET /growth/leads/:lead_id/activities - List lead activities

Patient Segments (9 endpoints)Copy Anchor Link

• GET /growth/patient_segments - List all segments
• POST /growth/patient_segments - Create new segment
• GET /growth/patient_segments/:id - Show segment details
• PATCH /growth/patient_segments/:id - Update segment
• DELETE /growth/patient_segments/:id - Delete segment
• POST /growth/patient_segments/:id/compute - Compute dynamic segment
• GET /growth/patient_segments/:id/members - List segment members
• POST /growth/patient_segments/:id/add_members - Add members to segment
• DELETE /growth/patient_segments/:id/remove_members - Remove members from segment

Communications (3 endpoints)Copy Anchor Link

• GET /growth/communications - List all communications
• GET /growth/communications/:id - Show communication details
• POST /growth/communications/:id/retry - Retry failed communication

Review Requests (4 endpoints)Copy Anchor Link

• GET /growth/review_requests - List all review requests
• POST /growth/review_requests - Create review request
• GET /growth/review_requests/:id - Show review request details
• POST /growth/review_requests/:id/send_reminder - Send review reminder

📝 StatisticsCopy Anchor Link

Total Files: 52 .bru files Total Endpoints: 42 API endpoints Folders: 7 resource categories Environments: 2 (local, staging)

🧪 Testing ExamplesCopy Anchor Link

Example 1: Create and Execute CampaignCopy Anchor Link

1. Create Campaign: Use Create campaign.bru
2. Add Messages: Use Create message.bru (nested under campaign)
3. Schedule Campaign: Use Schedule campaign.bru
4. Start Campaign: Use Start campaign.bru
5. Check Metrics: Use Get campaign metrics.bru

Example 2: Lead Management WorkflowCopy Anchor Link

1. Create Lead: Use Create lead.bru
2. Update Status: Use Update lead.bru to change status to "contacted"
3. Assign Lead: Use Assign lead.bru
4. Convert to Patient: Use Convert lead.bru
5. View Activities: Use List lead activities.bru

Example 3: Dynamic Patient SegmentationCopy Anchor Link

1. Create Segment: Use Create segment.bru with dynamic criteria
2. Compute Segment: Use Compute segment.bru to calculate members
3. View Members: Use List members.bru
4. Create Campaign: Target this segment in campaign

📚 Additional ResourcesCopy Anchor Link

• Growth Schema Documentation: docs/new-schema/plans/growth-schema-implementation.md
• Bruno Documentation: https://docs.usebruno.com/
• API Response Guidelines: docs/new-schema/guides/api-response-guidelines.md

🎯 Key FeaturesCopy Anchor Link

✅ 42 API endpoints fully documented ✅ Bearer authentication configured ✅ Environment variables for easy configuration ✅ Example responses for complex endpoints ✅ Organized folder structure matching API routes ✅ Multi-environment support (local, staging)

📄 LicenseCopy Anchor Link

Part of Kulcare API Backend - Internal use only

Last Updated: 2026-01-19 Version: 1.0 Location: kulcare-apis/Growth/ Maintainer: Kulcare Development Team