Kit · Schema
Update a broadcast Request
Email MarketingCreator EconomySubscribersAutomationNewslettersSequencesFormsBroadcasts
Properties
| Name | Type | Description |
|---|---|---|
| email_template_id | integer | Id of the email template to use. Uses the account's default template if not provided. 'Starting point' template is not supported. |
| email_address | string | The sending email address to use. Uses the account's sending email address if not provided. |
| content | string | The HTML content of the email. |
| description | string | |
| public | boolean | `true` to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages. |
| published_at | string | The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed. |
| send_at | string | The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed. |
| thumbnail_alt | object | |
| thumbnail_url | object | |
| preview_text | string | |
| subject | string | |
| subscriber_filter | array | Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. `all`, `any`, or `none` but no combinations). If nothing is provided, will default to all of |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/convertkit/main/json-schema/update_a_broadcast_request.json",
"title": "Update a broadcast Request",
"x-tag": "Broadcasts",
"type": "object",
"properties": {
"email_template_id": {
"type": "integer",
"description": "Id of the email template to use. Uses the account's default template if not provided. 'Starting point' template is not supported."
},
"email_address": {
"type": "string",
"nullable": true,
"description": "The sending email address to use. Uses the account's sending email address if not provided."
},
"content": {
"type": "string",
"description": "The HTML content of the email."
},
"description": {
"type": "string"
},
"public": {
"type": "boolean",
"description": "`true` to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages."
},
"published_at": {
"type": "string",
"description": "The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."
},
"send_at": {
"type": "string",
"description": "The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."
},
"thumbnail_alt": {
"nullable": true
},
"thumbnail_url": {
"nullable": true
},
"preview_text": {
"type": "string"
},
"subject": {
"type": "string"
},
"subscriber_filter": {
"type": "array",
"description": "Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. `all`, `any`, or `none` but no combinations). If nothing is provided, will default to all of your subscribers.",
"items": {
"type": "object",
"properties": {
"all": {
"type": "array",
"description": "Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "`segment` or `tag`"
},
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"type",
"ids"
]
}
},
"any": {
"type": "array",
"description": "Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "`segment` or `tag`"
},
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"type",
"ids"
]
},
"nullable": true
},
"none": {
"type": "array",
"description": "Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "`segment` or `tag`"
},
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"type",
"ids"
]
},
"nullable": true
}
},
"minProperties": 1,
"required": [
"all",
"any",
"none"
]
}
}
},
"required": [
"email_template_id",
"email_address",
"content",
"description",
"public",
"published_at",
"send_at",
"thumbnail_alt",
"thumbnail_url",
"preview_text",
"subject",
"subscriber_filter"
]
}