docs(campaigns): Campaigns REST API public docs#369
Open
aaryan-rawat wants to merge 20 commits into
Open
Conversation
Adds the Campaigns product to the docs site:
- Product landing (campaigns.mdx) with capabilities, common use cases,
and server-only positioning.
- Conceptual pages for Sequences and Analytics under campaigns/.
- REST API docs at rest-api/campaigns-apis/, covering 5 endpoints:
GET /channels, GET /channels/availability,
GET /templates, GET /templates/{templateId},
DELETE /notification-feed/{feedItemId}.
Includes an OpenAPI 3.0 spec (campaigns-apis.json), an overview with
response/error envelope and variable-resolution precedence, and a
Setup & Authentication page.
- Campaigns card on the home page (index.mdx).
- docs.json registers campaigns-apis.json and the Campaigns product
navigation (Campaigns and APIs tabs).
…I guide - Reorganize campaigns.mdx as overview with key capabilities and setup flow - Add new campaigns subdirectory with dedicated docs for channels, categories, templates, users, webhooks, and notification-settings - Expand API documentation with detailed endpoint reference, request/response examples, and field descriptions - Add prerequisites, limits, and supported channels reference tables - Include step-by-step setup instructions and common use case descriptions - Update docs.json to reflect new documentation structure and navigation hierarchy - Improve content organization for better discoverability and developer onboarding
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…e endpoint guides - Add 50+ new endpoint documentation files for campaigns, categories, channels, notifications, and templates - Expand analytics documentation with detailed metric endpoints for campaigns, channels, templates, and users - Add notification feed API documentation with filtering, pagination, and engagement tracking - Add push notifications API documentation with delivery and engagement reporting - Update campaigns-apis.json OpenAPI specification with complete endpoint definitions and parameters - Update campaigns.mdx and related guide files with restructured content - Update docs.json to reflect new documentation structure and organization
… and clarifying core concepts
… and unsupported options
… schema types - Mark onbehalfof header parameter as required across three API endpoints - Change variableSchema items type from string to object in template definitions - Update variable naming regex pattern to exclude dots and add end anchor - Align API schema with actual implementation requirements
…documentation - Make templateCategory parameter optional in API schema - Change limit parameter type from string to number and make optional - Update recipients limit terminology from "per notification" to "per API call" across all docs - Simplify Delete campaign description by removing reference to cancelled campaigns - Add default state clarification for channel enabled property (defaults to disabled) - Expand variable type documentation with specific format examples for string, image, and action types - Add note clarifying defaultValue support is limited to string type variables only - Remove temporary temp.md file
…e codes - Add default value of 20 to pagination limit parameters across all list endpoints - Document 404 error responses for item retrieval endpoints (feed items, push notifications) - Document 400 error responses for endpoints requiring onbehalfof header (mark as read/delivered, engagement events) - Remove unused UpdateSettingsDto and RecordEventDto schema definitions - Improve API specification completeness with consistent error documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the Campaigns product to the docs site:
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)