Add documentation: Email Functionality Documentation #18
Conversation
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
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.
Email Functionality Documentation
Email Overview
This document provides comprehensive information for developers and email integration specialists on how to utilize the email functionality within our platform. It covers various aspects, including authentication, creating, sending, and receiving emails, as well as webhook integration. This documentation complements the OpenAPI specification and provides practical examples to facilitate seamless integration.
Authentication
All email-related endpoints require authentication. You can authenticate using API keys or OAuth 2.0. Refer to the Authentication Documentation for detailed instructions on obtaining and using your credentials.
Example (API Key in Header):
Creating Emails
The
/v1/emails/{accountId}/create-emailendpoint allows you to create email drafts. These drafts can then be sent using the sending endpoint.Request: