{
  "opencollection": "1.0.0",
  "info": {
    "name": "Infobip OpenAPI Specification",
    "version": "3.210.0"
  },
  "items": [
    {
      "info": {
        "name": "channels",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Send a Messenger message",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/messenger/1/messages",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Send one or more messages to multiple recipients. <br/> Marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will fail with an error."
        },
        {
          "info": {
            "name": "Get Messenger delivery reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/messenger/1/reports",
            "params": [
              {
                "name": "bulkId",
                "value": "",
                "type": "query",
                "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address."
              },
              {
                "name": "messageId",
                "value": "",
                "type": "query",
                "description": "The ID that uniquely identifies the message sent."
              },
              {
                "name": "limit",
                "value": "1",
                "type": "query",
                "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h."
              },
              {
                "name": "entityId",
                "value": "promotional-traffic-entity",
                "type": "query",
                "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "applicationId",
                "value": "marketing-automation-application",
                "type": "query",
                "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "campaignReferenceId",
                "value": "summersale",
                "type": "query",
                "description": "ID of a campaign that was sent in the message."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once."
        },
        {
          "info": {
            "name": "Get outbound Messenger message logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/messenger/1/logs",
            "params": [
              {
                "name": "sender",
                "value": "",
                "type": "query",
                "description": "The sender ID which can be alphanumeric or numeric."
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "Message destination address."
              },
              {
                "name": "bulkId",
                "value": "BULK-ID-123-xyz",
                "type": "query",
                "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters."
              },
              {
                "name": "messageId",
                "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz",
                "type": "query",
                "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters."
              },
              {
                "name": "generalStatus",
                "value": "",
                "type": "query"
              },
              {
                "name": "sentSince",
                "value": "2020-02-22T17:42:05.390+01:00",
                "type": "query",
                "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
              },
              {
                "name": "sentUntil",
                "value": "2020-02-23T17:42:05.390+01:00",
                "type": "query",
                "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h."
              },
              {
                "name": "entityId",
                "value": "promotional-traffic-entity",
                "type": "query",
                "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "applicationId",
                "value": "marketing-automation-application",
                "type": "query",
                "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
              },
              {
                "name": "campaignReferenceId",
                "value": "summersale",
                "type": "query",
                "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values."
              },
              {
                "name": "useCursor",
                "value": "",
                "type": "query",
                "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours."
        },
        {
          "info": {
            "name": "Get marketing subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/messenger/1/pages/:pageId/subscriptions",
            "params": [
              {
                "name": "pageId",
                "value": "263213833541399",
                "type": "path",
                "description": "Page ID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get all messenger marketing subscriptions for single page. <br/> Collecting subscription tokens still works on the Messenger platform. However, marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will no longer be supported."
        },
        {
          "info": {
            "name": "Get campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/messenger/1/campaigns",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns all Facebook Messenger marketing campaigns for the authenticated account."
        },
        {
          "info": {
            "name": "Create campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/messenger/1/campaigns",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new Facebook Messenger marketing campaign to send marketing messages to opted-in users. The campaign is associated with your ad account and Facebook page."
        },
        {
          "info": {
            "name": "Delete campaign",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/messenger/1/campaigns/:campaignId",
            "params": [
              {
                "name": "campaignId",
                "value": "120213234151570",
                "type": "path",
                "description": "Campaign ID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete an existing Facebook Messenger marketing campaign."
        },
        {
          "info": {
            "name": "Get ad accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/messenger/1/ad-accounts",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns all Facebook ad accounts associated with the authenticated marketing account."
        },
        {
          "info": {
            "name": "Get audiences",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/messenger/1/audiences",
            "params": [
              {
                "name": "adAccountId",
                "value": "",
                "type": "query",
                "description": "Facebook ad account ID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve all custom audiences for the given ad account."
        },
        {
          "info": {
            "name": "Create custom audience",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/messenger/1/audiences",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new custom audience for marketing messages. Users can be uploaded to this audience to grow the marketing messages subscriber base."
        },
        {
          "info": {
            "name": "Delete audience",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/messenger/1/audiences/:audienceId",
            "params": [
              {
                "name": "audienceId",
                "value": "",
                "type": "path",
                "description": "Meta custom audience ID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete a custom audience. This permanently removes the audience from Meta and stops any campaigns using it."
        },
        {
          "info": {
            "name": "Upload users to audience",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/messenger/1/audiences/:audienceId/users",
            "params": [
              {
                "name": "audienceId",
                "value": "",
                "type": "path",
                "description": "Meta custom audience ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Upload hashed user data (SHA-256) to a custom audience. Meta matches this data against its user database to grow your marketing messages subscriber base. Maximum 10,000 users per request."
        },
        {
          "info": {
            "name": "Remove user from audience",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/messenger/1/audiences/:audienceId/users/:hashedPhoneNumber",
            "params": [
              {
                "name": "audienceId",
                "value": "",
                "type": "path",
                "description": "Meta custom audience ID."
              },
              {
                "name": "hashedPhoneNumber",
                "value": "",
                "type": "path",
                "description": "SHA-256 hashed phone number to remove."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Remove a single hashed phone number from a custom audience."
        }
      ]
    }
  ],
  "bundled": true
}