---
title: "Messages"
method: GET
path: "/marketing/v2/messages"
tags: ["offer-messages", "v2"]
---

# Messages

`GET /marketing/v2/messages`

Returns merchant marketing messages that are eligible for display in the requested placement location. Results may be filtered by merchant and profile and are returned in a paginated format.

## Query parameters

- `merchantId` string
- `profileId` string
- `messagePlacement` 'checkout' | 'checkoutPage' | 'checkoutMobile' | 'product' | 'productPage' | 'productMobile' | 'cart' | 'cartPage' | 'cartMobile'
- `nextToken` string
- `limit` integer

## Response `200`

OK

- PaginatedOfferMessageV2DTOResponse
  - `count` integer
  - `data` OfferMessageV2DTO[]
    - `merchantId` string
    - `profileId` string
    - `messageId` string
    - `startTimestamp` string
    - `endTimestamp` string
    - `messagePlacement` string
    - `contentHtml` string
    - `contentNodes` ContentNode[]
      - `type` 'HEADER' | 'SUBTEXT' | 'STRONG' | 'EMPHASIS' | 'ANCHOR' | 'IMAGE' | 'TEXT' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'STRIKETHROUGH'
      - `attributes` object
      - `content` string
      - `children` ContentNode[]
      - `messageId` string
  - `limit` integer
  - `nextToken` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.dev/paze/apis/paze-checkout-api.md) · [All operations](https://skmtc.dev/paze/apis/paze-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/paze/paze-checkout-api/revisions/81670e227b06/schema)
