Email Tagging and Classification

We have implemented these features to allow you to better keep track of the types of emails that you are sending via our programmatic email API. These features are experimental and we are happy to iterate on them based on user feedback.

Email Tagging

Our email sending API endpoint (/transactional/email/send) now accepts an optional tag field. This field accepts a string of up to 255 characters.

An example JSON payload making use of this tag field:

{
 "recipient": "[e-mail]",
 "subject": "Hello there",
 "body": "How are you",
 "classification": "FOR_ACTION",
 "tag": "Greetings v2"
}

In this example, the tag field is wholly defined by the API user. When the API user queries for the email using the email status API endpoint (/transactional/email/{id}), the tag field will be returned as part of the JSON object.

In the List Emails API, the API user can query for emails with a specific tag using the tag query parameter. For example, GET /transactional/email?tag=Greetings%20v2 will return all emails with the tag Greetings v2.

To make this feature more useful, we are considering generating monthly reports of the different emails based on these user-defined tags. If you have ideas for how this feature might be useful to you, please contact us.

Email Classification

Our email sending API endpoint (/transactional/email/send) now accepts an optional classification field. This fields accepts one of the following enums:

• URGENT

• FOR_ACTION

• FOR_INFO

An example JSON payload making use of this classification field:

{
 "recipient": "[e-mail]",
 "subject": "Hello there",
 "body": "How are you",
 "classification": "FOR_ACTION"
}

When the API user queries for the email using the email status API endpoint (/transactional/email/{id}), the classification field will be returned as part of the JSON object.

We encourage users to make use of this field. To make this feature more useful, we are considering priority sending of emails based on this classification. If you have ideas for how this feature might be useful to you, please contact us.