Kit · Schema

List broadcasts Response

Email MarketingCreator EconomySubscribersAutomationNewslettersSequencesFormsBroadcasts

Properties

Name Type Description
broadcasts array
pagination object
View JSON Schema on GitHub

JSON Schema

list_broadcasts_response.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/convertkit/main/json-schema/list_broadcasts_response.json",
  "title": "List broadcasts Response",
  "x-tag": "Broadcasts",
  "type": "object",
  "properties": {
    "broadcasts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "publication_id": {
            "type": "integer",
            "description": "Identifier of the underlying publication. Broadcasts that are also published as posts share the same `publication_id` \u2014 use it to match a broadcast to its post via `GET /v4/posts`."
          },
          "created_at": {
            "type": "string"
          },
          "subject": {
            "type": "string"
          },
          "preview_text": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "nullable": true
          },
          "public": {
            "type": "boolean"
          },
          "published_at": {
            "type": "string",
            "nullable": true
          },
          "send_at": {
            "type": "string",
            "nullable": true
          },
          "thumbnail_alt": {
            "type": "string",
            "nullable": true
          },
          "thumbnail_url": {
            "type": "string",
            "nullable": true
          },
          "public_url": {
            "type": "string",
            "nullable": true
          },
          "email_address": {
            "type": "string",
            "nullable": true
          },
          "email_template": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "subscriber_filter": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "all": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "type"
                    ]
                  }
                }
              },
              "required": [
                "all"
              ]
            }
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "publication_id",
          "created_at",
          "subject",
          "preview_text",
          "description",
          "public",
          "published_at",
          "send_at",
          "thumbnail_alt",
          "thumbnail_url",
          "content",
          "public_url",
          "email_address",
          "email_template",
          "subscriber_filter"
        ]
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "has_previous_page": {
          "type": "boolean"
        },
        "has_next_page": {
          "type": "boolean"
        },
        "start_cursor": {
          "type": "string"
        },
        "end_cursor": {
          "type": "string"
        },
        "per_page": {
          "type": "integer"
        }
      },
      "required": [
        "has_previous_page",
        "has_next_page",
        "start_cursor",
        "end_cursor",
        "per_page"
      ]
    }
  },
  "required": [
    "broadcasts",
    "pagination"
  ]
}