{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kit Accounts Broadcasts API",
    "version": "4.0"
  },
  "items": [
    {
      "info": {
        "name": "Broadcasts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List broadcasts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kit.com/v4/broadcasts",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "To fetch next page of results, use `?after=<end_cursor>`"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "To fetch previous page of results, use `?before=<start_cursor>`"
              },
              {
                "name": "include_total_count",
                "value": "false",
                "type": "query",
                "description": "Set to `true` to include the `total_count` in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Default 500, maximum 1000."
              },
              {
                "name": "sent_after",
                "value": "",
                "type": "query",
                "description": "Get broadcasts sent after this date (format yyyy-mm-dd)."
              },
              {
                "name": "sent_before",
                "value": "",
                "type": "query",
                "description": "Get broadcasts sent before this date (format yyyy-mm-dd)."
              },
              {
                "name": "slim",
                "value": "false",
                "type": "query",
                "description": "When `true`, omits expensive optional fields from the response. Produces a faster, smaller response — useful when extra fields are not needed."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "List broadcasts"
        },
        {
          "info": {
            "name": "Create a broadcast",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kit.com/v4/broadcasts",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Draft or schedule to send a broadcast to all or a subset of your subscribers.<br/><br/>To save a draft, set `send_at` to `null`.<br/><br/>To publish to the web, set `public` to `true`.<br/><br/>To schedule the broadcast for sending, provide a `send_at` timestamp. Scheduled broadcasts should contain a subject and your content, at a minimum.<br/><br/>We currently support targeting your subscribers based on segment or tag ids.<aside class='notice'>Starting point templates are not currently supporte"
        },
        {
          "info": {
            "name": "Get stats for a list of broadcasts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kit.com/v4/broadcasts/stats",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "To fetch next page of results, use `?after=<end_cursor>`"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "To fetch previous page of results, use `?before=<start_cursor>`"
              },
              {
                "name": "include_total_count",
                "value": "false",
                "type": "query",
                "description": "Set to `true` to include the `total_count` in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Default 500, maximum 1000."
              },
              {
                "name": "sent_after",
                "value": "",
                "type": "query"
              },
              {
                "name": "sent_before",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get stats for a list of broadcasts"
        },
        {
          "info": {
            "name": "Get link clicks for a broadcast",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kit.com/v4/broadcasts/:broadcast_id/clicks",
            "params": [
              {
                "name": "broadcast_id",
                "value": "169",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "NOTE: Pagination parameters control the list of clicks for the top level broadcast."
        },
        {
          "info": {
            "name": "Get stats for a broadcast",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kit.com/v4/broadcasts/:broadcast_id/stats",
            "params": [
              {
                "name": "broadcast_id",
                "value": "279",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get stats for a broadcast"
        },
        {
          "info": {
            "name": "Get a broadcast",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kit.com/v4/broadcasts/:id",
            "params": [
              {
                "name": "[]",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "59",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get a broadcast"
        },
        {
          "info": {
            "name": "Update a broadcast",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.kit.com/v4/broadcasts/:id",
            "params": [
              {
                "name": "id",
                "value": "106",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update an existing broadcast. Continue to draft or schedule to send a broadcast to all or a subset of your subscribers.<br/><br/>To save a draft, set `public` to false.<br/><br/>To schedule the broadcast for sending, set `public` to true and provide `send_at`. Scheduled broadcasts should contain a subject and your content, at a minimum.<br/><br/>We currently support targeting your subscribers based on segment or tag ids."
        },
        {
          "info": {
            "name": "Delete a broadcast",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.kit.com/v4/broadcasts/:id",
            "params": [
              {
                "name": "id",
                "value": "133",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Kit-Api-Key",
              "value": "{{X-Kit-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a broadcast"
        }
      ]
    }
  ],
  "bundled": true
}