/kit-contacts | Type: Application | PCID required: Yes
Tools
kit_contacts_delete_bulk_tags_subscribers
Bulk remove tags from subscriberskit_contacts_delete_custom_fields_id
Delete custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_contacts_delete_tags_tag_id_subscribers
Remove tag from subscriber by email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag_id | integer | Yes | — | Tag Id |
kit_contacts_delete_tags_tag_id_subscribers_id
Remove tag from subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
tag_id | integer | Yes | — | Tag Id |
kit_contacts_delete_webhooks_id
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_contacts_get_account
Get current accountkit_contacts_get_account_colors
List colorskit_contacts_get_account_creator_profile
Get Creator Profilekit_contacts_get_account_email_stats
Get email statskit_contacts_get_account_growth_stats
Get growth stats Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ending | string | No | — | Get stats for time period ending on this date (format yyyy-mm-dd). Defaults to today. |
starting | string | No | — | Get 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:| 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_contacts_get_purchases
List purchases 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_contacts_get_purchases_id
Get a purchase Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_contacts_get_segments
List segments 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_contacts_get_subscribers
List subscribers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | string | No | — | To fetch next page of results, use ?after=<end_cursor> |
before | string | 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) |
email_address | string | No | — | Email Address |
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 | number | No | — | Number of results per page. Default 500, maximum 1000. |
sort_field | string | No | — | Sort Field |
sort_order | string | No | — | Sort Order |
status | string | No | — | Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active. |
updated_after | string | No | — | Filter subscribers who have been updated after this date (format yyyy-mm-dd) |
updated_before | string | No | — | Filter subscribers who have been updated before this date (format yyyy-mm-dd) |
kit_contacts_get_subscribers_id
Get a subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_contacts_get_subscribers_subscriber_id_stats
List stats for a subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_sent_after | string | No | — | Filter 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_before | string | No | — | Filter 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_id | integer | Yes | — | Subscriber Id |
kit_contacts_get_subscribers_subscriber_id_tags
List tags for a subscriber 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. |
subscriber_id | integer | Yes | — | Subscriber Id |
kit_contacts_get_tags
List tags 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_contacts_get_tags_tag_id_subscribers
List subscribers for a tag 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> |
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. |
status | string | No | — | Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active. |
tag_id | integer | Yes | — | Tag Id |
tagged_after | string | No | — | Filter subscribers who have been tagged after this date (format yyyy-mm-dd) |
tagged_before | string | No | — | Filter subscribers who have been tagged before this date (format yyyy-mm-dd) |
kit_contacts_get_webhooks
List webhooks 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_contacts_post_bulk_custom_fields
Bulk create custom fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | string | No | — | Callback Url |
custom_fields | object[] | Yes | — | Custom Fields |
kit_contacts_post_bulk_custom_fields_subscribers
Bulk update subscriber custom field values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | object | Yes | — | Callback Url |
custom_field_values | object[] | Yes | — | Custom Field Values |
kit_contacts_post_bulk_subscribers
Bulk create subscribers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | string | No | — | Callback Url |
subscribers | object[] | Yes | — | The subscribers value |
kit_contacts_post_bulk_tags
Bulk create tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | string | No | — | Callback Url |
tags | object[] | Yes | — | The tags value |
kit_contacts_post_bulk_tags_subscribers
Bulk tag subscribers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | string | No | — | Callback Url |
taggings | object[] | Yes | — | The taggings value |
kit_contacts_post_custom_fields
Create a custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label | string | Yes | — | The label value |
kit_contacts_post_purchases
Create a purchase Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purchase | object | Yes | — | The purchase value |
kit_contacts_post_subscribers
Create a subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address | string | Yes | — | Email Address |
fields | object | No | — | The fields value |
first_name | string | No | — | First Name |
state | string | No | — | Create subscriber in this state (active, bounced, cancelled, complained or inactive). Defaults to active. |
kit_contacts_post_subscribers_filter
Filter subscribers based on engagement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
all | object[] | Yes | — | Array of filter conditions where ALL must be met (AND logic) |
kit_contacts_post_subscribers_id_unsubscribe
Unsubscribe subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
kit_contacts_post_tags
Create a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
kit_contacts_post_tags_tag_id_subscribers
Tag a subscriber by email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag_id | integer | Yes | — | Tag Id |
email_address | string | Yes | — | Email Address |
kit_contacts_post_tags_tag_id_subscribers_id
Tag a subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
tag_id | integer | Yes | — | Tag Id |
kit_contacts_post_webhooks
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event | object | Yes | — | The event value |
target_url | string | Yes | — | Target Url |
kit_contacts_put_account_colors
Update colors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
colors | string[] | No | — | An array of up to 10 color hex codes |
kit_contacts_put_custom_fields_id
Update a custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
label | string | No | — | The label value |
kit_contacts_put_subscribers_id
Update a subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
email_address | string | No | — | Email Address |
fields | object | No | — | The fields value |
first_name | string | No | — | First Name |
kit_contacts_put_tags_id
Update tag name Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
name | string | No | — | The name value |

