addedInput schema / $defs
Added value: +{
+ "all_item": {
+ "additionalProperties": false,
+ "properties": {
+ "ids": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "`segment` or `tag`",
+ "enum": [
+ "segment",
+ "tag"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "ids"
+ ],
+ "type": "object"
+ },
+ "content": {
+ "description": "The HTML content of the email. On a `Classic` template this is the body, and the template adds the design around it when the broadcast is sent. On a `Starting point` template the design lives in the body, so this is the complete email: keep the wrappers, images, inline styles and Liquid tags, including `{{ unsubscribe_url }}` and `{{ address }}`. Without an unsubscribe link the broadcast can't be sent. A read returns the string that was written, so `GET`, `PUT`, `GET` round-trips, apart from Kit's own \"Built with Kit\" badge, which a `Starting point` write takes out of the body and re-applies when the email renders. A broadcast built in Kit's editor reads back as Kit's rendered HTML instead, and writing that back replaces its individually-editable blocks with one HTML block. Sending `content` in the same request as a `Starting point` `email_template_id` also needs `allow_starting_point: true`. Omit `content` and name a `Starting point` template in `email_template_id` to create the broadcast with that template's own design.",
+ "type": "string"
+ },
+ "subscriber_filter": {
+ "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": {
+ "additionalProperties": false,
+ "minProperties": 1,
+ "properties": {
+ "all": {
+ "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": {
+ "$ref": "#/$defs/all_item"
+ },
+ "type": "array"
+ },
+ "any": {
+ "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": {
+ "$ref": "#/$defs/all_item"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "none": {
+ "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": {
+ "$ref": "#/$defs/all_item"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "all",
+ "any",
+ "none"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+}
changedInput schema / properties / confirm / description
Previous value: -"Must be true for audience/delivery changes, publishing, destructive operations and signing-secret changes. Use only for an action requested by the user."New value: +"Set true only when the user asked for exactly this action."
addedInput schema / properties / content / $ref
Added value: +"#/$defs/content"
removedInput schema / properties / content / description
Removed value: -"The HTML content of the email. On a `Classic` template this is the body, and the template adds the design around it when the broadcast is sent. On a `Starting point` template the design lives in the body, so this is the complete email: keep the wrappers, images, inline styles and Liquid tags, including `{{ unsubscribe_url }}` and `{{ address }}`. Without an unsubscribe link the broadcast can't be sent. A read returns the string that was written, so `GET`, `PUT`, `GET` round-trips, apart from Kit's own \"Built with Kit\" badge, which a `Starting point` write takes out of the body and re-applies when the email renders. A broadcast built in Kit's editor reads back as Kit's rendered HTML instead, and writing that back replaces its individually-editable blocks with one HTML block. Sending `content` in the same request as a `Starting point` `email_template_id` also needs `allow_starting_point: true`. Omit `content` and name a `Starting point` template in `email_template_id` to create the broadcast with that template's own design."
removedInput schema / properties / content / type
Removed value: -"string"
addedInput schema / properties / payload / properties / content / $ref
Added value: +"#/$defs/content"
removedInput schema / properties / payload / properties / content / description
Removed value: -"The HTML content of the email. On a `Classic` template this is the body, and the template adds the design around it when the broadcast is sent. On a `Starting point` template the design lives in the body, so this is the complete email: keep the wrappers, images, inline styles and Liquid tags, including `{{ unsubscribe_url }}` and `{{ address }}`. Without an unsubscribe link the broadcast can't be sent. A read returns the string that was written, so `GET`, `PUT`, `GET` round-trips, apart from Kit's own \"Built with Kit\" badge, which a `Starting point` write takes out of the body and re-applies when the email renders. A broadcast built in Kit's editor reads back as Kit's rendered HTML instead, and writing that back replaces its individually-editable blocks with one HTML block. Sending `content` in the same request as a `Starting point` `email_template_id` also needs `allow_starting_point: true`. Omit `content` and name a `Starting point` template in `email_template_id` to create the broadcast with that template's own design."
removedInput schema / properties / payload / properties / content / type
Removed value: -"string"
addedInput schema / properties / payload / properties / subscriber_filter / $ref
Added value: +"#/$defs/subscriber_filter"
removedInput schema / properties / payload / properties / subscriber_filter / description
Removed value: -"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."
removedInput schema / properties / payload / properties / subscriber_filter / items
Removed value: -{
- "additionalProperties": false,
- "minProperties": 1,
- "properties": {
- "all": {
- "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": {
- "additionalProperties": false,
- "properties": {
- "ids": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": {
- "description": "`segment` or `tag`",
- "enum": [
- "segment",
- "tag"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "ids"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "any": {
- "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": {
- "additionalProperties": false,
- "properties": {
- "ids": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": {
- "description": "`segment` or `tag`",
- "enum": [
- "segment",
- "tag"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "ids"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "none": {
- "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": {
- "additionalProperties": false,
- "properties": {
- "ids": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": {
- "description": "`segment` or `tag`",
- "enum": [
- "segment",
- "tag"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "ids"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- }
- },
- "required": [
- "all",
- "any",
- "none"
- ],
- "type": "object"
-}
removedInput schema / properties / payload / properties / subscriber_filter / type
Removed value: -"array"
addedInput schema / properties / subscriber_filter / $ref
Added value: +"#/$defs/subscriber_filter"
removedInput schema / properties / subscriber_filter / description
Removed value: -"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."
removedInput schema / properties / subscriber_filter / items
Removed value: -{
- "additionalProperties": false,
- "minProperties": 1,
- "properties": {
- "all": {
- "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": {
- "additionalProperties": false,
- "properties": {
- "ids": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": {
- "description": "`segment` or `tag`",
- "enum": [
- "segment",
- "tag"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "ids"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "any": {
- "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": {
- "additionalProperties": false,
- "properties": {
- "ids": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": {
- "description": "`segment` or `tag`",
- "enum": [
- "segment",
- "tag"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "ids"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "none": {
- "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": {
- "additionalProperties": false,
- "properties": {
- "ids": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": {
- "description": "`segment` or `tag`",
- "enum": [
- "segment",
- "tag"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "ids"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- }
- },
- "required": [
- "all",
- "any",
- "none"
- ],
- "type": "object"
-}
removedInput schema / properties / subscriber_filter / type
Removed value: -"array"