v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

EmbeddedMessage

Get Embedded Messaging user messages for a specific container using POST

post/api/v1/embedded-messages/get-embedded-messages

Query parameters

CustomerIdstring

Example:Optimove

Customer Id

VisitorIdstring

Example:optimove

IsVisitor boolean

LocalTimenumber double

        Customer local time offset in minutes. Optional, defaults to 0 if not specified. This is the UTC
        offset of the customers timezone (typically identified from browser timezone) e.g. if customer is
        at +1 hour timezone then pass +60.
        


        This field is used for evaluating message expiry etc. Consistently passing 0 results in measuring all
        times as UTC rather than customer local timezone.

TenantIdinteger

Example:1

TenantId Id

BrandIdstring uuid

Example:f29e20e6-53eb-4a79-a004-09fe308d63de

Brand Id.

Request body

containerIdstring nullable

Container id to filter messages by

limitinteger nullable

Maximum number of messages to return

Response

If the request is successful, this response an dictionary of user messages based on the containerId.

containersobject nullable