Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List of high level APIs for the MVP #2

Open
spannercode opened this issue Jan 10, 2025 · 1 comment
Open

List of high level APIs for the MVP #2

spannercode opened this issue Jan 10, 2025 · 1 comment
Assignees

Comments

@spannercode
Copy link
Member

This is a placeholder ticket for listing all high level APIs for the mail service. This should include the following:

  1. API to send email (refer sendgrid API)
  2. Templates API
  3. Contacts API (subscribe/unsubscribe)
  4. APIs for the Dashboard (overview/stats)
@Kanak1125 Kanak1125 self-assigned this Jan 10, 2025
@Kanak1125
Copy link
Collaborator

Kanak1125 commented Jan 13, 2025

  1. API to send email (refer sendgrid API)
    GET /api/emails/:emailId - Get the email from id (used for the draft)
    POST /api/emails/send - Send an email
    PATCH /api/emails/:emailId- Update the drafted email before sending it.
    DELETE /api/emails/:emailId - Delete the draft for the email.

  2. Templates APIs
    GET /api/templates - Get templates
    POST /api/templates - Create a new template
    PATCH /api/templates/:templateId - Update a template
    DELETE /api/templates/:templateId - delete a template

  3. Contacts API (subscribe/unsubscribe)
    GET /api/contacts/:listId - Get all the contacts associated with the contact list of specific id
    POST /api/contacts/:listId - Create a new contact
    PATCH /api/contacts/:contactId - Update the contact's status (subscribe / unsubscribe )
    DELETE /api/contacts/:contactId - Delete a contact
    GET /api/contacts - Get all the contacts regardless of the contact lists.

  4. APIs for the Dashboard (overview/stats)
    GET /api/dashboard/stats - Get the stats data

@Kanak1125 Kanak1125 reopened this Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants