Push

GET Retrieve all push messages in your account.

GET /push/v1/message

Operation ID: Get Push Messages.

To execute this operation, you must have the Channels | Push | Read permission.

Parameters

• Authorization (header, string, required) A unique, time-limited token that you can use to issue requests to the Marketing Cloud Engagement API. Replace YOUR_ACCESS_TOKEN with your authentication token.

  Example

  Bearer YOUR_ACCESS_TOKEN

• $page (query, string) The page of results to retrieve. Each page includes the number of records specified by the $pagesize parameter. You can retrieve additional pages by incrementing this number in subsequent calls.
• $pageSize (query, number) The number of records to return on each page of results. The default value is 25.
• $filter (query, string) A filter to apply to the results. You can filter on the values of the messageType, contentType, and status fields. Filters can include these operators: eq, neq, lt, lte, gt, gte, and like. Separate each filter statement with a space.
• $orderBy (query, string) The field and sort method to use to sort the results. You can sort on these fields: id, name, statusId, status, scheduledDate, application, applicationId, app, campaign, sendMethodId, subject, geofenceId, createdDate, and lastUpdated. You can sort these fields in ascending (ASC) or descending (DESC) order.

Responses

• 200 This response indicates that the API accepted the request to retrieve a push message.

  Media type: application/json. Schema: getPushResponseBody.

  Example

  {
    "count": 2,
    "page": 1,
    "pageSize": 50,
    "links": {},
    "items": [
      {
        "links": {},
        "id": "MzexMTV6BM",
        "messageType": 1,
        "contentType": 1,
        "messageObjectId": "ab2182e3-d0dd-47d0-893a-1228fe0b8c9b",
        "application": {
          "links": {},
          "messageCategories": [
            {
              "id": 16,
              "name": "MyApp",
              "buttons": []
            }
          ],
          "id": "bc93a43d-a227-432e-844e-2cb6eac2ae75",
          "key": "UGVjcXZDZwT2ZWlMa09FVGl5Mjt4UToxMTc6MA",
          "name": "My Push Message",
          "description": "",
          "createdDate": "2023-11-29T00:17:00Z",
          "modifiedDate": "2023-11-29T00:19:24.923Z",
          "configuration": {
            "customSound": false,
            "openDirect": false,
            "customKeys": false,
            "payloadEditor": false,
            "messageCategories": false
          }
        },
        "name": "My Message",
        "tzPastSendAction": 0,
        "sendInitiator": 1,
        "status": 1,
        "activeTimes": [],
        "createdDate": "2024-06-10T17:15:00",
        "lastUpdated": "2024-06-10T17:16:00"
      },
      {
        "id": "MzeyMTV6BM",
        "alert": "This is a message",
        "sound": "default",
        "badge": "+1",
        "startDateUtc": "2023-11-29T00:21:00.000Z",
        "startDate": "2023-11-28T18:21:00",
        "messageType": 1,
        "contentType": 1,
        "messageObjectId": "6d691c6a-9881-4341-bebf-6a0148c74282",
        "application": {
          "id": "bc2ae73d-a227-432e-844e-2cb6ea93a4c5",
          "key": "UGVjcXZDZWlMa09FVGl5MjZwT2t4UToxMTc6MA",
          "name": "My Message 2",
          "description": "",
          "createdDate": "2023-11-29T00:17:00Z",
          "modifiedDate": "2023-11-29T00:19:24.923Z",
          "configuration": {
            "customSound": false,
            "openDirect": false,
            "customKeys": false,
            "payloadEditor": false,
            "messageCategories": true
          }
        },
        "name": "Testing123",
        "tzPastSendAction": 0,
        "sendInitiator": 0,
        "status": 1,
        "title": "Message",
        "createdDate": "2023-11-28T18:20:00",
        "lastUpdated": "2023-11-28T18:21:00",
        "isDuplicationAllowed": false,
        "currentEditStep": 4,
        "scheduledTimezone": {
          "offset": -6,
          "name": "Central Standard Time (no DST)"
        }
      }
    ]
  }

• 401 This response indicates that the API wasn’t able to authorize your request. When you receive a 401 response, verify that you obtained an authorization token and that the token is still valid.

  Media type: application/json. Schema: httpErrorResponseBody.

  Example

  {
    "documentation": "https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/error-handling.htm",
    "errorcode": 0,
    "message": "Not Authorized"
  }

• 403 This response indicates that the API accepted your request but couldn’t authorize it. When you receive a 403 response, make sure you have the necessary permission scope for the operation. You can modify permission scopes on the Installed Apps page in Marketing Cloud Engagement Setup.

  Media type: application/json. Schema: mceErrorResponseBody.

  Example

  {
    "message": "Contact your Marketing Cloud administrator for permission to Schedule and Send Message",
    "errorcode": 20002,
    "documentation": ""
  }