Transactional Messaging - Push

GET Retrieve a list of transactional push send definitions in your account.

GET /messaging/v1/push/definitions

Operation ID: Get Push Send Definitions.

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

Responses

• 200 This response indicates that the API accepted the request to retrieve a list of send definitions.

  Media type: application/json. Schema: sendDefGetResponseBody.

  Example

  {
    "requestId": "1a46adb0-4dfa-44c9-ba48-a7794fa29328",
    "definitions": [
      {
        "name": "Defn Key 1",
        "definitionKey": "DKey1",
        "status": "Active",
        "createdDate": "2024-02-22T17:38:00",
        "modifiedDate": "2024-02-22T17:38:00"
      },
      {
        "name": "Defn Key 10",
        "definitionKey": "DKey10",
        "status": "Active",
        "createdDate": "2024-02-22T21:24:00",
        "modifiedDate": "2024-02-22T21:24:00"
      }
    ],
    "count": 2,
    "page": 1,
    "pageSize": 50
  }

• 401 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

  {
    "documentation": "",
    "errorcode": 20002,
    "message": "Insufficient privileges to complete this action."
  }