Skip to main content
Server path: /kit-marketing | Type: Application | PCID required: Yes

Tools


kit_marketing_delete_broadcasts_id

Delete a broadcast Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_marketing_delete_sequences_id

Delete a sequence Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_marketing_get_broadcasts

List broadcasts Parameters:
ParameterTypeRequiredDefaultDescription
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.
sent_afterobjectNoGet broadcasts sent after this date (format yyyy-mm-dd).
sent_beforeobjectNoGet broadcasts sent before this date (format yyyy-mm-dd).

kit_marketing_get_broadcasts_broadcast_id_clicks

Get link clicks for a broadcast Parameters:
ParameterTypeRequiredDefaultDescription
broadcast_idintegerYesBroadcast Id

kit_marketing_get_broadcasts_broadcast_id_stats

Get stats for a broadcast Parameters:
ParameterTypeRequiredDefaultDescription
broadcast_idintegerYesBroadcast Id

kit_marketing_get_broadcasts_id

Get a broadcast Parameters:
ParameterTypeRequiredDefaultDescription
[]stringNoThe [] value
idintegerYesThe id value

kit_marketing_get_broadcasts_stats

Get stats for a list of broadcasts

kit_marketing_get_email_templates

List email templates Parameters:
ParameterTypeRequiredDefaultDescription
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.

kit_marketing_get_forms

List forms Parameters:
ParameterTypeRequiredDefaultDescription
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.
statusstringNoFilter forms that have this status (active, archived, trashed, or all). Defaults to active.
typeobjectNoFilter 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:
ParameterTypeRequiredDefaultDescription
added_afterstringNoFilter subscribers who have been added to the form after this date (format yyyy-mm-dd)
added_beforestringNoFilter subscribers who have been added to the form before this date (format yyyy-mm-dd)
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
created_afterstringNoFilter subscribers who have been created after this date (format yyyy-mm-dd)
created_beforestringNoFilter subscribers who have been created before this date (format yyyy-mm-dd)
form_idintegerYesForm Id
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.
statusstringNoFilter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.

kit_marketing_get_posts

List posts Parameters:
ParameterTypeRequiredDefaultDescription
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
include_contentbooleanNoTo 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_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.

kit_marketing_get_posts_id

Get a post Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_marketing_get_sequences

List sequences Parameters:
ParameterTypeRequiredDefaultDescription
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.

kit_marketing_get_sequences_id

Get a sequence Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_marketing_get_sequences_sequence_id_subscribers

List subscribers for a sequence Parameters:
ParameterTypeRequiredDefaultDescription
added_afterstringNoFilter subscribers who have been added to the form after this date (format yyyy-mm-dd)
added_beforestringNoFilter subscribers who have been added to the form before this date (format yyyy-mm-dd)
afterobjectNoTo fetch next page of results, use ?after=<end_cursor>
beforeobjectNoTo fetch previous page of results, use ?before=<start_cursor>
created_afterstringNoFilter subscribers who have been created after this date (format yyyy-mm-dd)
created_beforestringNoFilter subscribers who have been created before this date (format yyyy-mm-dd)
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pageobjectNoNumber of results per page. Default 500, maximum 1000.
sequence_idintegerYesSequence Id
statusstringNoFilter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.

kit_marketing_post_broadcasts

Create a broadcast Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe HTML content of the email.
descriptionstringYesThe description value
email_addressstringNoThe sending email address to use. Uses the account’s sending email address if not provided.
email_template_idintegerNoId of the email template to use. Uses the account’s default template if not provided. ‘Starting point’ template is not supported.
preview_textstringYesPreview Text
publicbooleanYestrue to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages.
published_atstringYesThe published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed.
send_atstringNoThe scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed.
subjectstringYesThe subject value
subscriber_filterobject[]YesFilters 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_altstringNoThumbnail Alt
thumbnail_urlstringNoThumbnail Url

kit_marketing_post_bulk_forms_subscribers

Bulk add subscribers to forms Parameters:
ParameterTypeRequiredDefaultDescription
additionsobject[]YesThe additions value
callback_urlstringNoCallback Url

kit_marketing_post_forms_form_id_subscribers

Add subscriber to form by email address Parameters:
ParameterTypeRequiredDefaultDescription
form_idintegerYesForm Id
email_addressstringYesEmail Address
referrerstringNoThe referrer value

kit_marketing_post_forms_form_id_subscribers_id

Add subscriber to form Parameters:
ParameterTypeRequiredDefaultDescription
form_idintegerYesForm Id
idintegerYesThe id value
referrerstringYesThe referrer value

kit_marketing_post_sequences

Create a sequence Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNotrue to activate the sequence, false to deactivate it.
email_addressstringNoThe sending email address to use. Uses the account’s sending email address if not provided.
email_template_idintegerNoId of the email template to use.
exclude_subscriber_sourcesobject[]NoThe subscriber sources to exclude from the sequence.
holdbooleanNoWhen true, subscribers added via Visual Automations stay in the sequence after receiving the last email.
namestringNoThe name of the sequence.
repeatbooleanNoWhen true, subscribers can restart the sequence multiple times.
send_daysstring[]NoThe days of the week to send the sequence on. Must be one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
send_hourintegerNoThe hour of the day to send the sequence at. Must be an integer between 0 and 23.
time_zonestringNoThe 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:
ParameterTypeRequiredDefaultDescription
sequence_idintegerYesSequence Id
email_addressstringYesEmail Address

kit_marketing_post_sequences_sequence_id_subscribers_id

Add subscriber to sequence Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
sequence_idintegerYesSequence Id

kit_marketing_put_broadcasts_id

Update a broadcast Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
contentstringNoThe HTML content of the email.
descriptionstringNoThe description value
email_addressstringNoThe sending email address to use. Uses the account’s sending email address if not provided.
email_template_idintegerNoId of the email template to use. Uses the account’s default template if not provided. ‘Starting point’ template is not supported.
preview_textstringNoPreview Text
publicbooleanNotrue to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages.
published_atstringNoThe published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed.
send_atstringNoThe scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed.
subjectstringNoThe subject value
subscriber_filterobject[]NoFilters 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_altobjectNoThumbnail Alt
thumbnail_urlobjectNoThumbnail Url

kit_marketing_put_sequences_id

Update a sequence Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
activebooleanNotrue to activate the sequence, false to deactivate it.
email_addressstringNoThe sending email address to use. Uses the account’s sending email address if not provided.
email_template_idintegerNoId of the email template to use.
exclude_subscriber_sourcesobject[]NoThe subscriber sources to exclude from the sequence.
holdbooleanNoWhen true, subscribers added via Visual Automations stay in the sequence after receiving the last email.
namestringNoThe name of the sequence.
repeatbooleanNoWhen true, subscribers can restart the sequence multiple times.
send_daysstring[]NoThe days of the week to send the sequence on. Must be one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
send_hourintegerNoThe hour of the day to send the sequence at. Must be an integer between 0 and 23.
time_zonestringNoThe timezone to use for the sequence. Must be a valid IANA timezone string.