Messages

Overview

Retrieve and manage the messages sent to a person. Messages enables developers to list a person’s messages, open a single message, and update its status across WEX platforms. It includes operations for retrieving messages with filters, retrieving one message, and updating a message. Use this resource to build inbox experiences that keep consumers informed, show unread counts, and let them mark messages as read, archived, or favorite.

Why use the API?

• Modernization: It provides a standardized, clear, and modern RESTful endpoint, making it easier to integrate with current systems.
• Integration: It allows you to easily consume and integrate message data, powering your own consumer-facing experiences.
• Growth & Innovation: Using our API, you can improve your own products and create a smoother experience for your customers and consumers.

What can the API do?

The Messages API allows you to perform functions related to the person’s:

• Message list
• Individual messages
• Message status (read, archived, and favorite)

Key Features

• Returns a paginated list of messages, filtered by read, archived, and favorite status.
• Limits results to a date range. The range defaults to the last three years through now.
• Includes an unread message count in the list response, so you can show a badge without extra calls.
• Returns a single message by its message_id, including subject, content, sender, receiver, status flags, and attached documents.
• Allows you to update a message by sending the full message in the request body.

Messages API Operations

The Messages API includes the following operations. Select the API Reference tab to find functional information about each one.

• Get Messages
• Get Message
• Update Message