Skip to content
Waypoint documentation
Changelog

Email message metadata

A small but mighty improvement for dev teams – metadata is now supported on Waypoint email messages. This allows teams to attach additional context for internal use and reference.

For example, when sending an email API via the API, you might want to include extra context. In the snippet below, we’re passing in a customerId, companyId, and transactionId:

POST v1/email_messages
Terminal window
curl "https://live.waypointapi.com/v1/email_messages" \
  -H "Content-Type: application/json" \
  -u "API_KEY_USERNAME:API_KEY_PASSWORD"  \
  -d '{
    "to": "jordan@usewaypoint.com",
    "templateId": "wptemplate_tuVKkNrLgZfM6KyQ",
    "variables": {
      "displayName": "Jordan"
    },
    "metadata": {
      "customerId": "customer_10928q3093840aap",
      "companyId": "company_sdafljaw09330r36",
      "transactionId": "transaction_a20394a339aa390a"
    }
  }'

This metadata isn’t just available when fetching individual emails API — it’s also included visible on message detail pages in your dashboard.

Updated docs

Additionally, message metadata is also accessible from webhook payloads. Example:

{
  "createdAt": "2025-04-21T14:03:01.357Z",
  "emailMessage": {
    ...
    "metadata": {
      "customerId": "customer_10928q3093840aap",
      "companyId": "company_sdafljaw09330r36",
      "transactionId": "transaction_a20394a339aa390a"
    }
  },
  "emailMessageId": "em_wUpG2hHHvfncz8EY",
  "id": "log_vJayu2MEA7ZZXTuQ",
  "message": "Email successfully delivered to jordan@usewaypoint.com. Delivery time: 0.2 seconds.",
  "updatedAt": "2025-04-21T14:03:01.357Z"
}