{
  "opencollection": "1.0.0",
  "info": {
    "name": "Courier Audiences Sent Messages API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Sent Messages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.courier.com/messages",
            "params": [
              {
                "name": "archived",
                "value": "",
                "type": "query",
                "description": "A boolean value that indicates whether archived messages should be included in the response."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A unique identifier that allows for fetching the next set of messages."
              },
              {
                "name": "event",
                "value": "",
                "type": "query",
                "description": "A unique identifier representing the event that was used to send the event."
              },
              {
                "name": "list",
                "value": "",
                "type": "query",
                "description": "A unique identifier representing the list the message was sent to."
              },
              {
                "name": "messageId",
                "value": "",
                "type": "query",
                "description": "A unique identifier representing the message_id returned from either /send or /send/list."
              },
              {
                "name": "notification",
                "value": "",
                "type": "query",
                "description": "A unique identifier representing the notification that was used to send the event."
              },
              {
                "name": "provider",
                "value": "",
                "type": "query",
                "description": "The key assocated to the provider you want to filter on. E.g., sendgrid, inbox, twilio, slack, msteams, etc. Allows multiple values to be set in query parameters."
              },
              {
                "name": "recipient",
                "value": "",
                "type": "query",
                "description": "A unique identifier representing the recipient associated with the requested profile."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "An indicator of the current status of the message. Allows multiple values to be set in query parameters."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in."
              },
              {
                "name": "tenant_id",
                "value": "",
                "type": "query",
                "description": "Messages sent with the context of a Tenant"
              },
              {
                "name": "enqueued_after",
                "value": "",
                "type": "query",
                "description": "The enqueued datetime of a message to filter out messages received before."
              },
              {
                "name": "traceId",
                "value": "",
                "type": "query",
                "description": "The unique identifier used to trace the requests"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch the statuses of messages you've previously sent."
        },
        {
          "info": {
            "name": "Get message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.courier.com/messages/:message_id",
            "params": [
              {
                "name": "message_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier associated with the message you wish to retrieve (results from a send)."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch the status of a message you've previously sent."
        },
        {
          "info": {
            "name": "Cancel message",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.courier.com/messages/:message_id/cancel",
            "params": [
              {
                "name": "message_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier representing the message ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below)."
        },
        {
          "info": {
            "name": "Get message history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.courier.com/messages/:message_id/history",
            "params": [
              {
                "name": "message_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier representing the message ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "A supported Message History type that will filter the events returned."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch the array of events of a message you've previously sent."
        },
        {
          "info": {
            "name": "Get message content",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.courier.com/messages/:message_id/output",
            "params": [
              {
                "name": "message_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier associated with the message you wish to retrieve (results from a send)."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get message content"
        },
        {
          "info": {
            "name": "Archive message",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.courier.com/requests/:request_id/archive",
            "params": [
              {
                "name": "request_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier representing the request ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Archive message"
        }
      ]
    }
  ],
  "bundled": true
}