/kit-contacts | Type: Application | PCID required: Yes
Tools
kit_contacts_delete_bulk_tags_subscribers
Bulk remove tags from subscribers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | string | No | — | URL to notify when the bulk operation is complete. |
taggings | object[] | Yes | — | Array of tag/subscriber pairs to untag. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callback_url": {
"type": "string",
"description": "URL to notify when the bulk operation is complete."
},
"taggings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag_id": {
"type": "integer",
"description": "The tag ID to remove."
},
"subscriber_id": {
"type": "integer",
"description": "The subscriber ID to remove the tag from."
}
}
},
"description": "Array of tag/subscriber pairs to untag."
}
},
"required": [
"PCID",
"taggings"
]
}
kit_contacts_delete_custom_fields_id
Delete custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
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 |
email_address | string | Yes | — | The email address of the subscriber to remove from this tag. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tag_id": {
"type": "integer",
"description": "Tag Id"
},
"email_address": {
"type": "string",
"description": "The email address of the subscriber to remove from this tag."
}
},
"required": [
"PCID",
"tag_id",
"email_address"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"tag_id": {
"type": "integer",
"description": "Tag Id"
}
},
"required": [
"PCID",
"id",
"tag_id"
]
}
kit_contacts_delete_webhooks_id
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
kit_contacts_get_account
Get current accountShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
kit_contacts_get_account_colors
List colorsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
kit_contacts_get_account_creator_profile
Get Creator ProfileShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
kit_contacts_get_account_email_stats
Get email statsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
kit_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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ending": {
"type": "string",
"description": "Get stats for time period ending on this date (format yyyy-mm-dd). Defaults to today."
},
"starting": {
"type": "string",
"description": "Get stats for time period beginning on this date (format yyyy-mm-dd). Defaults to 90 days ago."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
}
},
"required": [
"PCID"
]
}
kit_contacts_get_purchases_id
Get a purchase Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
}
},
"required": [
"PCID"
]
}
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) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"type": "string",
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"created_after": {
"type": "string",
"description": "Filter subscribers who have been created after this date (format yyyy-mm-dd)"
},
"created_before": {
"type": "string",
"description": "Filter subscribers who have been created before this date (format yyyy-mm-dd)"
},
"email_address": {
"type": "string",
"description": "Email Address"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"type": "number",
"description": "Number of results per page. Default 500, maximum 1000."
},
"sort_field": {
"type": "string",
"description": "Sort Field"
},
"sort_order": {
"type": "string",
"description": "Sort Order",
"enum": [
"asc",
"desc"
]
},
"status": {
"type": "string",
"description": "Filter subscribers who have this status (`active`, `inactive`, `bounced`, `complained`, `cancelled` or `all`). Defaults to `active`.",
"enum": [
"active",
"inactive",
"bounced",
"complained",
"cancelled",
"all"
]
},
"updated_after": {
"type": "string",
"description": "Filter subscribers who have been updated after this date (format yyyy-mm-dd)"
},
"updated_before": {
"type": "string",
"description": "Filter subscribers who have been updated before this date (format yyyy-mm-dd)"
}
},
"required": [
"PCID"
]
}
kit_contacts_get_subscribers_id
Get a subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_sent_after": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "Subscriber Id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
},
"subscriber_id": {
"type": "integer",
"description": "Subscriber Id"
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
}
},
"required": [
"PCID"
]
}
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) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"created_after": {
"type": "string",
"description": "Filter subscribers who have been created after this date (format yyyy-mm-dd)"
},
"created_before": {
"type": "string",
"description": "Filter subscribers who have been created before this date (format yyyy-mm-dd)"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
},
"status": {
"type": "string",
"description": "Filter subscribers who have this status (`active`, `inactive`, `bounced`, `complained`, `cancelled` or `all`). Defaults to `active`.",
"enum": [
"active",
"inactive",
"bounced",
"complained",
"cancelled",
"all"
]
},
"tag_id": {
"type": "integer",
"description": "Tag Id"
},
"tagged_after": {
"type": "string",
"description": "Filter subscribers who have been tagged after this date (format yyyy-mm-dd)"
},
"tagged_before": {
"type": "string",
"description": "Filter subscribers who have been tagged before this date (format yyyy-mm-dd)"
}
},
"required": [
"PCID",
"tag_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"description": "To fetch next page of results, use `?after=<end_cursor>`"
},
"before": {
"description": "To fetch previous page of results, use `?before=<start_cursor>`"
},
"include_total_count": {
"type": "boolean",
"description": "To include the total count of records in the response, use `true`. For large collections, expect a slightly slower response."
},
"per_page": {
"description": "Number of results per page. Default 500, maximum 1000."
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callback_url": {
"type": "string",
"description": "Callback Url"
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label value"
}
},
"required": [
"label"
]
},
"description": "Custom Fields"
}
},
"required": [
"PCID",
"custom_fields"
]
}
kit_contacts_post_bulk_custom_fields_subscribers
Bulk update subscriber custom field values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | object | No | — | Callback Url |
custom_field_values | object[] | Yes | — | Custom Field Values |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callback_url": {
"description": "Callback Url"
},
"custom_field_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subscriber_id": {
"type": "integer",
"description": "Subscriber Id"
},
"subscriber_custom_field_id": {
"type": "integer",
"description": "Subscriber Custom Field Id"
},
"value": {
"type": "string",
"description": "The value value"
}
},
"required": [
"subscriber_id",
"subscriber_custom_field_id",
"value"
]
},
"description": "Custom Field Values"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callback_url": {
"type": "string",
"description": "Callback Url"
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First Name"
},
"email_address": {
"type": "string",
"description": "Email Address"
},
"state": {
"type": "string",
"enum": [
"active",
"cancelled",
"bounced",
"complained",
"inactive"
],
"description": "The state value"
}
}
},
"description": "The subscribers value"
}
},
"required": [
"PCID",
"subscribers"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callback_url": {
"type": "string",
"description": "Callback Url"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"name"
]
},
"description": "The tags value"
}
},
"required": [
"PCID",
"tags"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callback_url": {
"type": "string",
"description": "Callback Url"
},
"taggings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag_id": {
"type": "integer",
"description": "Tag Id"
},
"subscriber_id": {
"type": "integer",
"description": "Subscriber Id"
}
},
"required": [
"tag_id",
"subscriber_id"
]
},
"description": "The taggings value"
}
},
"required": [
"PCID",
"taggings"
]
}
kit_contacts_post_custom_fields
Create a custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label | string | Yes | — | The label value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"label": {
"type": "string",
"description": "The label value"
}
},
"required": [
"PCID",
"label"
]
}
kit_contacts_post_purchases
Create a purchase Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purchase | object | Yes | — | The purchase value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"purchase": {
"type": "object",
"description": "The purchase value",
"properties": {
"email_address": {
"type": "string",
"description": "The subscriber that the purchase belongs to"
},
"transaction_id": {
"type": "string",
"description": "Transaction Id"
},
"status": {
"type": "string",
"description": "The status value"
},
"subtotal": {
"type": "number",
"description": "The subtotal value"
},
"tax": {
"type": "number",
"description": "The tax value"
},
"shipping": {
"type": "integer",
"description": "The shipping value"
},
"discount": {
"type": "number",
"description": "The discount value"
},
"total": {
"type": "number",
"description": "The total value"
},
"currency": {
"type": "string",
"description": "3 letter currency code (e.g. `USD`)"
},
"transaction_time": {
"type": "string",
"description": "Transaction Time"
},
"products": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of purchased products"
}
},
"required": [
"email_address",
"transaction_id",
"status",
"subtotal",
"tax",
"shipping",
"discount",
"total",
"currency",
"transaction_time",
"products"
]
}
},
"required": [
"PCID",
"purchase"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_address": {
"type": "string",
"description": "Email Address"
},
"fields": {
"type": "object",
"description": "The fields value",
"properties": {
"Last name": {
"type": "string",
"description": "Last Name"
},
"Birthday": {
"type": "string",
"description": "The birthday value"
},
"Source": {
"type": "string",
"description": "The source value"
},
"Role": {
"type": "string",
"description": "The role value"
},
"Company": {
"type": "string",
"description": "The company value"
},
"Postal code": {
"type": "string",
"description": "Postal Code"
},
"Website": {
"type": "string",
"description": "The website value"
},
"Social media": {
"type": "string",
"description": "Social Media"
},
"How did you hear about us?": {
"type": "string",
"description": "How Did You Hear About Us?"
},
"Interests": {
"type": "string",
"description": "The interests value"
},
"Coupon": {
"type": "string",
"description": "The coupon value"
},
"Phone Number": {
"type": "string",
"description": "Phone Number"
},
"Enrolled in Coaching": {
"type": "string",
"description": "Enrolled In Coaching"
},
"Lead Score": {
"type": "string",
"description": "Lead Score"
}
}
},
"first_name": {
"type": "string",
"description": "First Name"
},
"state": {
"type": "string",
"description": "Create subscriber in this state (`active`, `bounced`, `cancelled`, `complained` or `inactive`). Defaults to `active`.",
"enum": [
"active",
"cancelled",
"bounced",
"complained",
"inactive"
]
}
},
"required": [
"PCID",
"email_address"
]
}
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) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"all": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"opens",
"clicks",
"sent",
"delivered",
"subscribed"
],
"description": "Type of filter condition"
},
"count_greater_than": {
"type": "integer",
"description": "Minimum count (exclusive). Not applicable for 'subscribed' type."
},
"count_less_than": {
"type": "integer",
"description": "Maximum count (exclusive). Not applicable for 'subscribed' type."
},
"after": {
"type": "string",
"format": "date",
"description": "Start date (YYYY-MM-DD). For 'subscribed' type, filters by subscriber_created_at. For other types, filters by event date."
},
"before": {
"type": "string",
"format": "date",
"description": "End date (YYYY-MM-DD). For 'subscribed' type, filters by subscriber_created_at. For other types, filters by event date."
},
"any": {
"type": "array",
"description": "Array of OR conditions for filtering by specific broadcasts or URLs. Subscriber activity must match ANY of these conditions. Not applicable for 'subscribed' type."
}
},
"required": [
"type"
]
},
"description": "Array of filter conditions where ALL must be met (AND logic)"
}
},
"required": [
"PCID",
"all"
]
}
kit_contacts_post_subscribers_id_unsubscribe
Unsubscribe subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
kit_contacts_post_tags
Create a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tag_id": {
"type": "integer",
"description": "Tag Id"
},
"email_address": {
"type": "string",
"description": "Email Address"
}
},
"required": [
"PCID",
"tag_id",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"tag_id": {
"type": "integer",
"description": "Tag Id"
}
},
"required": [
"PCID",
"id",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event": {
"type": "object",
"description": "The event value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"form_id": {
"description": "Form Id"
},
"tag_id": {
"description": "Tag Id"
},
"sequence_id": {
"description": "Sequence Id"
},
"product_id": {
"description": "Product Id"
},
"initiator_value": {
"description": "Initiator Value"
},
"custom_field_id": {
"description": "Custom Field Id"
}
},
"required": [
"name"
]
},
"target_url": {
"type": "string",
"description": "Target Url"
}
},
"required": [
"PCID",
"event",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"colors": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of up to 10 color hex codes"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"label": {
"type": "string",
"description": "The label value"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"email_address": {
"type": "string",
"description": "Email Address"
},
"fields": {
"type": "object",
"description": "The fields value",
"properties": {
"Last name": {
"type": "string",
"description": "Last Name"
},
"Birthday": {
"type": "string",
"description": "The birthday value"
},
"Source": {
"type": "string",
"description": "The source value"
},
"Role": {
"type": "string",
"description": "The role value"
},
"Company": {
"type": "string",
"description": "The company value"
},
"Postal code": {
"type": "string",
"description": "Postal Code"
},
"Website": {
"type": "string",
"description": "The website value"
},
"Social media": {
"type": "string",
"description": "Social Media"
},
"How did you hear about us?": {
"type": "string",
"description": "How Did You Hear About Us?"
},
"Interests": {
"type": "string",
"description": "The interests value"
},
"Coupon": {
"type": "string",
"description": "The coupon value"
}
}
},
"first_name": {
"type": "string",
"description": "First Name"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}

