/kit-marketing | Type: Application | PCID required: Yes
Tools
kit_marketing_delete_broadcasts_id
Delete a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_marketing_delete_sequences_id
Delete a sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_marketing_get_broadcasts
List broadcasts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
sent_after | object | No | — | Get broadcasts sent after this date (format yyyy-mm-dd). |
sent_before | object | No | — | Get broadcasts sent before this date (format yyyy-mm-dd). |
kit_marketing_get_broadcasts_broadcast_id_clicks
Get link clicks for a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
broadcast_id | integer | Yes | — | Broadcast Id |
kit_marketing_get_broadcasts_broadcast_id_stats
Get stats for a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
broadcast_id | integer | Yes | — | Broadcast Id |
kit_marketing_get_broadcasts_id
Get a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
[] | string | No | — | The [] value |
id | integer | Yes | — | The id value |
kit_marketing_get_broadcasts_stats
Get stats for a list of broadcastskit_marketing_get_email_templates
List email templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
kit_marketing_get_forms
List forms Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
status | string | No | — | Filter forms that have this status (active, archived, trashed, or all). Defaults to active. |
type | object | No | — | Filter forms and landing pages by type. Use embed for embedded forms. Use hosted for landing pages. |
kit_marketing_get_forms_form_id_subscribers
List subscribers for a form Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
added_after | string | No | — | Filter subscribers who have been added to the form after this date (format yyyy-mm-dd) |
added_before | string | No | — | Filter subscribers who have been added to the form before this date (format yyyy-mm-dd) |
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
created_after | string | No | — | Filter subscribers who have been created after this date (format yyyy-mm-dd) |
created_before | string | No | — | Filter subscribers who have been created before this date (format yyyy-mm-dd) |
form_id | integer | Yes | — | Form Id |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
status | string | No | — | Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active. |
kit_marketing_get_posts
List posts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
include_content | boolean | No | — | To include the content field on each post in the response, use true. Omitted by default because it significantly increases response size and latency for large collections. |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
kit_marketing_get_posts_id
Get a post Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_marketing_get_sequences
List sequences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
kit_marketing_get_sequences_id
Get a sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_marketing_get_sequences_sequence_id_subscribers
List subscribers for a sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
added_after | string | No | — | Filter subscribers who have been added to the form after this date (format yyyy-mm-dd) |
added_before | string | No | — | Filter subscribers who have been added to the form before this date (format yyyy-mm-dd) |
after | object | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | object | No | — | To fetch previous page of results, use ?before=<start_cursor> |
created_after | string | No | — | Filter subscribers who have been created after this date (format yyyy-mm-dd) |
created_before | string | No | — | Filter subscribers who have been created before this date (format yyyy-mm-dd) |
include_total_count | boolean | No | — | To include the total count of records in the response, use true. For large collections, expect a slightly slower response. |
per_page | object | No | — | Number of results per page. Default 500, maximum 1000. |
sequence_id | integer | Yes | — | Sequence Id |
status | string | No | — | Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active. |
kit_marketing_post_broadcasts
Create a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content | string | Yes | — | The HTML content of the email. |
description | string | Yes | — | The description value |
email_address | string | No | — | The sending email address to use. Uses the account’s sending email address if not provided. |
email_template_id | integer | No | — | Id of the email template to use. Uses the account’s default template if not provided. ‘Starting point’ template is not supported. |
preview_text | string | Yes | — | Preview Text |
public | boolean | Yes | — | 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 | Yes | — | The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed. |
send_at | string | No | — | The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed. |
subject | string | Yes | — | The subject value |
subscriber_filter | object[] | Yes | — | 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. |
thumbnail_alt | string | No | — | Thumbnail Alt |
thumbnail_url | string | No | — | Thumbnail Url |
kit_marketing_post_bulk_forms_subscribers
Bulk add subscribers to forms Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additions | object[] | Yes | — | The additions value |
callback_url | string | No | — | Callback Url |
kit_marketing_post_forms_form_id_subscribers
Add subscriber to form by email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
form_id | integer | Yes | — | Form Id |
email_address | string | Yes | — | Email Address |
referrer | string | No | — | The referrer value |
kit_marketing_post_forms_form_id_subscribers_id
Add subscriber to form Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
form_id | integer | Yes | — | Form Id |
id | integer | Yes | — | The id value |
referrer | string | Yes | — | The referrer value |
kit_marketing_post_sequences
Create a sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | true to activate the sequence, false to deactivate it. |
email_address | string | No | — | The sending email address to use. Uses the account’s sending email address if not provided. |
email_template_id | integer | No | — | Id of the email template to use. |
exclude_subscriber_sources | object[] | No | — | The subscriber sources to exclude from the sequence. |
hold | boolean | No | — | When true, subscribers added via Visual Automations stay in the sequence after receiving the last email. |
name | string | No | — | The name of the sequence. |
repeat | boolean | No | — | When true, subscribers can restart the sequence multiple times. |
send_days | string[] | No | — | The days of the week to send the sequence on. Must be one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday. |
send_hour | integer | No | — | The hour of the day to send the sequence at. Must be an integer between 0 and 23. |
time_zone | string | No | — | The timezone to use for the sequence. Must be a valid IANA timezone string. |
kit_marketing_post_sequences_sequence_id_subscribers
Add subscriber to sequence by email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sequence_id | integer | Yes | — | Sequence Id |
email_address | string | Yes | — | Email Address |
kit_marketing_post_sequences_sequence_id_subscribers_id
Add subscriber to sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
sequence_id | integer | Yes | — | Sequence Id |
kit_marketing_put_broadcasts_id
Update a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
content | string | No | — | The HTML content of the email. |
description | string | No | — | The description value |
email_address | string | No | — | The sending email address to use. Uses the account’s sending email address if not provided. |
email_template_id | integer | No | — | Id of the email template to use. Uses the account’s default template if not provided. ‘Starting point’ template is not supported. |
preview_text | string | No | — | Preview Text |
public | boolean | No | — | 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 | No | — | The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed. |
send_at | string | No | — | The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed. |
subject | string | No | — | The subject value |
subscriber_filter | object[] | No | — | 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. |
thumbnail_alt | object | No | — | Thumbnail Alt |
thumbnail_url | object | No | — | Thumbnail Url |
kit_marketing_put_sequences_id
Update a sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
active | boolean | No | — | true to activate the sequence, false to deactivate it. |
email_address | string | No | — | The sending email address to use. Uses the account’s sending email address if not provided. |
email_template_id | integer | No | — | Id of the email template to use. |
exclude_subscriber_sources | object[] | No | — | The subscriber sources to exclude from the sequence. |
hold | boolean | No | — | When true, subscribers added via Visual Automations stay in the sequence after receiving the last email. |
name | string | No | — | The name of the sequence. |
repeat | boolean | No | — | When true, subscribers can restart the sequence multiple times. |
send_days | string[] | No | — | The days of the week to send the sequence on. Must be one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday. |
send_hour | integer | No | — | The hour of the day to send the sequence at. Must be an integer between 0 and 23. |
time_zone | string | No | — | The timezone to use for the sequence. Must be a valid IANA timezone string. |

