This section provides detailed technical documentation for the Optimove Embedded Messaging V2 REST API.

While we strongly recommend using the Optimove Web SDK for all standard implementations, this API reference is for developers who need to build a deeply customized user interface from scratch.

Base URLs

The API domain you call will vary depending on the region your tenant is provisioned in.

• EU: https://optimobile-inbox-srv-eu.optimove.net
• US: https://optimobile-inbox-srv-us.optimove.net

Authentication & Required Parameters

All V2 API endpoints require the following query parameters for authentication and routing:

• tenantId: Your tenant ID.
• brandId: The ID of the specific brand you are targeting.

You can find these values on the Web Inbox settings page in your Optimove instance.

User Identification

To retrieve messages or report events for a specific user, you must identify them in your request. All endpoints that deal with user data require at least one of the following identifiers:

• customerId
• visitorId

API Endpoints

• [POST] /api/v2/embedded-messages/get: Fetches messages for one or more containers for a given user.
• [POST] /api/v2/embedded-messages/report-events: Reports user engagement events like reads, clicks, and deletes.