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

Tools

ToolDescription
kit_contacts_delete_bulk_tags_subscribersBulk remove tags from subscribers
kit_contacts_delete_custom_fields_idDelete custom field
kit_contacts_delete_tags_tag_id_subscribersRemove tag from subscriber by email address
kit_contacts_delete_tags_tag_id_subscribers_idRemove tag from subscriber
kit_contacts_delete_webhooks_idDelete a webhook
kit_contacts_get_accountGet current account
kit_contacts_get_account_colorsList colors
kit_contacts_get_account_creator_profileGet Creator Profile
kit_contacts_get_account_email_statsGet email stats
kit_contacts_get_account_growth_statsGet growth stats
kit_contacts_get_custom_fieldsList custom fields
kit_contacts_get_purchasesList purchases
kit_contacts_get_purchases_idGet a purchase
kit_contacts_get_segmentsList segments
kit_contacts_get_subscribersList subscribers
kit_contacts_get_subscribers_idGet a subscriber
kit_contacts_get_subscribers_subscriber_id_statsList stats for a subscriber
kit_contacts_get_subscribers_subscriber_id_tagsList tags for a subscriber
kit_contacts_get_tagsList tags
kit_contacts_get_tags_tag_id_subscribersList subscribers for a tag
kit_contacts_get_webhooksList webhooks
kit_contacts_post_bulk_custom_fieldsBulk create custom fields
kit_contacts_post_bulk_custom_fields_subscribersBulk update subscriber custom field values
kit_contacts_post_bulk_subscribersBulk create subscribers
kit_contacts_post_bulk_tagsBulk create tags
kit_contacts_post_bulk_tags_subscribersBulk tag subscribers
kit_contacts_post_custom_fieldsCreate a custom field
kit_contacts_post_purchasesCreate a purchase
kit_contacts_post_subscribersCreate a subscriber
kit_contacts_post_subscribers_filterFilter subscribers based on engagement
kit_contacts_post_subscribers_id_unsubscribeUnsubscribe subscriber
kit_contacts_post_tagsCreate a tag
kit_contacts_post_tags_tag_id_subscribersTag a subscriber by email address
kit_contacts_post_tags_tag_id_subscribers_idTag a subscriber
kit_contacts_post_webhooksCreate a webhook
kit_contacts_put_account_colorsUpdate colors
kit_contacts_put_custom_fields_idUpdate a custom field
kit_contacts_put_subscribers_idUpdate a subscriber
kit_contacts_put_tags_idUpdate tag name

kit_contacts_delete_bulk_tags_subscribers

Bulk remove tags from subscribers

kit_contacts_delete_custom_fields_id

Delete custom field Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_contacts_delete_tags_tag_id_subscribers

Remove tag from subscriber by email address Parameters:
ParameterTypeRequiredDefaultDescription
tag_idintegerYesTag Id

kit_contacts_delete_tags_tag_id_subscribers_id

Remove tag from subscriber Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
tag_idintegerYesTag Id

kit_contacts_delete_webhooks_id

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_contacts_get_account

Get current account

kit_contacts_get_account_colors

List colors

kit_contacts_get_account_creator_profile

Get Creator Profile

kit_contacts_get_account_email_stats

Get email stats

kit_contacts_get_account_growth_stats

Get growth stats Parameters:
ParameterTypeRequiredDefaultDescription
endingstringNoGet stats for time period ending on this date (format yyyy-mm-dd). Defaults to today.
startingstringNoGet stats for time period beginning on this date (format yyyy-mm-dd). Defaults to 90 days ago.

kit_contacts_get_custom_fields

List custom fields 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_contacts_get_purchases

List purchases 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_contacts_get_purchases_id

Get a purchase Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_contacts_get_segments

List segments 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_contacts_get_subscribers

List subscribers Parameters:
ParameterTypeRequiredDefaultDescription
afterstringNoTo fetch next page of results, use ?after=<end_cursor>
beforestringNoTo 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)
email_addressstringNoEmail Address
include_total_countbooleanNoTo include the total count of records in the response, use true. For large collections, expect a slightly slower response.
per_pagenumberNoNumber of results per page. Default 500, maximum 1000.
sort_fieldstringNoSort Field
sort_orderstringNoSort Order
statusstringNoFilter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.
updated_afterstringNoFilter subscribers who have been updated after this date (format yyyy-mm-dd)
updated_beforestringNoFilter subscribers who have been updated before this date (format yyyy-mm-dd)

kit_contacts_get_subscribers_id

Get a subscriber Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_contacts_get_subscribers_subscriber_id_stats

List stats for a subscriber Parameters:
ParameterTypeRequiredDefaultDescription
email_sent_afterstringNoFilter to stats for emails sent after this date (YYYY-MM-DD)/nNOTE: This functionality was added 2025-06-28 and will only include stats for emails sent before this date.
email_sent_beforestringNoFilter to stats for emails sent before this date (YYYY-MM-DD)/nNote: this functionality was added in June 2025, so no data for events before that date will be included.
subscriber_idintegerYesSubscriber Id

kit_contacts_get_subscribers_subscriber_id_tags

List tags for a subscriber 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.
subscriber_idintegerYesSubscriber Id

kit_contacts_get_tags

List tags 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_contacts_get_tags_tag_id_subscribers

List subscribers for a tag Parameters:
ParameterTypeRequiredDefaultDescription
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.
statusstringNoFilter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.
tag_idintegerYesTag Id
tagged_afterstringNoFilter subscribers who have been tagged after this date (format yyyy-mm-dd)
tagged_beforestringNoFilter subscribers who have been tagged before this date (format yyyy-mm-dd)

kit_contacts_get_webhooks

List webhooks 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_contacts_post_bulk_custom_fields

Bulk create custom fields Parameters:
ParameterTypeRequiredDefaultDescription
callback_urlstringNoCallback Url
custom_fieldsobject[]YesCustom Fields

kit_contacts_post_bulk_custom_fields_subscribers

Bulk update subscriber custom field values Parameters:
ParameterTypeRequiredDefaultDescription
callback_urlobjectYesCallback Url
custom_field_valuesobject[]YesCustom Field Values

kit_contacts_post_bulk_subscribers

Bulk create subscribers Parameters:
ParameterTypeRequiredDefaultDescription
callback_urlstringNoCallback Url
subscribersobject[]YesThe subscribers value

kit_contacts_post_bulk_tags

Bulk create tags Parameters:
ParameterTypeRequiredDefaultDescription
callback_urlstringNoCallback Url
tagsobject[]YesThe tags value

kit_contacts_post_bulk_tags_subscribers

Bulk tag subscribers Parameters:
ParameterTypeRequiredDefaultDescription
callback_urlstringNoCallback Url
taggingsobject[]YesThe taggings value

kit_contacts_post_custom_fields

Create a custom field Parameters:
ParameterTypeRequiredDefaultDescription
labelstringYesThe label value

kit_contacts_post_purchases

Create a purchase Parameters:
ParameterTypeRequiredDefaultDescription
purchaseobjectYesThe purchase value

kit_contacts_post_subscribers

Create a subscriber Parameters:
ParameterTypeRequiredDefaultDescription
email_addressstringYesEmail Address
fieldsobjectNoThe fields value
first_namestringNoFirst Name
statestringNoCreate subscriber in this state (active, bounced, cancelled, complained or inactive). Defaults to active.

kit_contacts_post_subscribers_filter

Filter subscribers based on engagement Parameters:
ParameterTypeRequiredDefaultDescription
allobject[]YesArray of filter conditions where ALL must be met (AND logic)

kit_contacts_post_subscribers_id_unsubscribe

Unsubscribe subscriber Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

kit_contacts_post_tags

Create a tag Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value

kit_contacts_post_tags_tag_id_subscribers

Tag a subscriber by email address Parameters:
ParameterTypeRequiredDefaultDescription
tag_idintegerYesTag Id
email_addressstringYesEmail Address

kit_contacts_post_tags_tag_id_subscribers_id

Tag a subscriber Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
tag_idintegerYesTag Id

kit_contacts_post_webhooks

Create a webhook Parameters:
ParameterTypeRequiredDefaultDescription
eventobjectYesThe event value
target_urlstringYesTarget Url

kit_contacts_put_account_colors

Update colors Parameters:
ParameterTypeRequiredDefaultDescription
colorsstring[]NoAn array of up to 10 color hex codes

kit_contacts_put_custom_fields_id

Update a custom field Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
labelstringNoThe label value

kit_contacts_put_subscribers_id

Update a subscriber Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
email_addressstringNoEmail Address
fieldsobjectNoThe fields value
first_namestringNoFirst Name

kit_contacts_put_tags_id

Update tag name Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
namestringNoThe name value