{
  "opencollection": "1.0.0",
  "info": {
    "name": "engageSPARK Balance WhatsApp API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "WhatsApp",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Send WhatsApp Message",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.engagespark.com/v1/whatsapp/contact",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send a single WhatsApp message to a contact. If there is no existing contact with the phone number a contact will be created.\n\nExactly one of \"contactId\", \"fullPhoneNumber\", or \"phoneNumber\" with \"phoneNumberCountry\" need to be set.\n\nRetries: The WhatsApp API automatically re-tries failed messages as often as possible within 24 hours by default. To know until when we'll keep retrying your message, you can refer to the deliveryDeadline of the POST response."
        },
        {
          "info": {
            "name": "List WhatsApp messages for an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.engagespark.com/v1/organizations/:orgId/whatsapp/",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "engageSPARK ID of the organization.\nYou can find this ID in your [Organization Profile](https://app.engagespark.com/organization/info)."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "See \"nextPage\" in the response."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results per API call."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Show this page. Starts at 1!"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Used when ?page is set. The default and the maximum is 1000."
              },
              {
                "name": "dir",
                "value": "",
                "type": "query",
                "description": "Limit to only egress, only ingress, or all directions. An empty value is the same as \"all\"."
              },
              {
                "name": "failed",
                "value": "",
                "type": "query",
                "description": "Limit to/exclude failed deliveries. Failed means the message didn't get delivered at all. Delivery Receipts are not taken into account here. An empty value is the same as \"all\"."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Keyword search in the message, sender, receiver, and contact fields."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The creation time of the message must be >= this timestamp."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The creation time of the message must be < this timestamp."
              }
            ]
          },
          "docs": "List WhatsApp messages. Newest first.\n\nThe number of results per API call is limited. Either use \"nextPage\" and \"after\" to get more results, which work as a cursor, and do not change as new messages come in. Or use \"page\" and \"size\", which are classical paging, and might change as new messages come in."
        },
        {
          "info": {
            "name": "Get a single WhatsApp message by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.engagespark.com/v1/organizations/:orgId/whatsapp/:messageId/",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "engageSPARK ID of the organization.\nYou can find this ID in your [Organization Profile](https://app.engagespark.com/organization/info)."
              },
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "ID of the WhatsApp message."
              }
            ]
          },
          "docs": "Load a WhatsApp message, including its delivery status."
        }
      ]
    }
  ],
  "bundled": true
}