> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# kit-marketing

> Kit Marketing - broadcasts, sequences, forms, email templates, and posts

**Server path:** `/kit-marketing` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                  | Description                                 |
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [`kit_marketing_delete_broadcasts_id`](#kit_marketing_delete_broadcasts_id)                                           | Delete a broadcast                          |
| [`kit_marketing_delete_sequences_id`](#kit_marketing_delete_sequences_id)                                             | Delete a sequence                           |
| [`kit_marketing_get_broadcasts`](#kit_marketing_get_broadcasts)                                                       | List broadcasts                             |
| [`kit_marketing_get_broadcasts_broadcast_id_clicks`](#kit_marketing_get_broadcasts_broadcast_id_clicks)               | Get link clicks for a broadcast             |
| [`kit_marketing_get_broadcasts_broadcast_id_stats`](#kit_marketing_get_broadcasts_broadcast_id_stats)                 | Get stats for a broadcast                   |
| [`kit_marketing_get_broadcasts_id`](#kit_marketing_get_broadcasts_id)                                                 | Get a broadcast                             |
| [`kit_marketing_get_broadcasts_stats`](#kit_marketing_get_broadcasts_stats)                                           | Get stats for a list of broadcasts          |
| [`kit_marketing_get_email_templates`](#kit_marketing_get_email_templates)                                             | List email templates                        |
| [`kit_marketing_get_forms`](#kit_marketing_get_forms)                                                                 | List forms                                  |
| [`kit_marketing_get_forms_form_id_subscribers`](#kit_marketing_get_forms_form_id_subscribers)                         | List subscribers for a form                 |
| [`kit_marketing_get_posts`](#kit_marketing_get_posts)                                                                 | List posts                                  |
| [`kit_marketing_get_posts_id`](#kit_marketing_get_posts_id)                                                           | Get a post                                  |
| [`kit_marketing_get_sequences`](#kit_marketing_get_sequences)                                                         | List sequences                              |
| [`kit_marketing_get_sequences_id`](#kit_marketing_get_sequences_id)                                                   | Get a sequence                              |
| [`kit_marketing_get_sequences_sequence_id_subscribers`](#kit_marketing_get_sequences_sequence_id_subscribers)         | List subscribers for a sequence             |
| [`kit_marketing_post_broadcasts`](#kit_marketing_post_broadcasts)                                                     | Create a broadcast                          |
| [`kit_marketing_post_bulk_forms_subscribers`](#kit_marketing_post_bulk_forms_subscribers)                             | Bulk add subscribers to forms               |
| [`kit_marketing_post_forms_form_id_subscribers`](#kit_marketing_post_forms_form_id_subscribers)                       | Add subscriber to form by email address     |
| [`kit_marketing_post_forms_form_id_subscribers_id`](#kit_marketing_post_forms_form_id_subscribers_id)                 | Add subscriber to form                      |
| [`kit_marketing_post_sequences`](#kit_marketing_post_sequences)                                                       | Create a sequence                           |
| [`kit_marketing_post_sequences_sequence_id_subscribers`](#kit_marketing_post_sequences_sequence_id_subscribers)       | Add subscriber to sequence by email address |
| [`kit_marketing_post_sequences_sequence_id_subscribers_id`](#kit_marketing_post_sequences_sequence_id_subscribers_id) | Add subscriber to sequence                  |
| [`kit_marketing_put_broadcasts_id`](#kit_marketing_put_broadcasts_id)                                                 | Update a broadcast                          |
| [`kit_marketing_put_sequences_id`](#kit_marketing_put_sequences_id)                                                   | Update a sequence                           |

***

## kit\_marketing\_delete\_broadcasts\_id

Delete a broadcast

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_delete\_sequences\_id

Delete a sequence

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_broadcasts

List broadcasts

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                                                                                  |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `after`               | object  | No       | —       | To fetch next page of results, use `?after=&lt;end_cursor&gt;`                                                               |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                        |
| `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).                                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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."
      },
      "sent_after": {
        "description": "Get broadcasts sent after this date (format yyyy-mm-dd)."
      },
      "sent_before": {
        "description": "Get broadcasts sent before this date (format yyyy-mm-dd)."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "broadcast_id": {
        "type": "integer",
        "description": "Broadcast Id"
      }
    },
    "required": [
      "PCID",
      "broadcast_id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_broadcasts\_broadcast\_id\_stats

Get stats for a broadcast

**Parameters:**

| Parameter      | Type    | Required | Default | Description  |
| -------------- | ------- | -------- | ------- | ------------ |
| `broadcast_id` | integer | Yes      | —       | Broadcast Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "broadcast_id": {
        "type": "integer",
        "description": "Broadcast Id"
      }
    },
    "required": [
      "PCID",
      "broadcast_id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_broadcasts\_id

Get a broadcast

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_broadcasts\_stats

Get stats for a list of broadcasts

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_email\_templates

List email templates

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                                                                                  |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `after`               | object  | No       | —       | To fetch next page of results, use `?after=&lt;end_cursor&gt;`                                                               |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                        |
| `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.                                                                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_forms

List forms

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                                                                                  |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `after`               | object  | No       | —       | To fetch next page of results, use `?after=&lt;end_cursor&gt;`                                                               |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                        |
| `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.                      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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."
      },
      "status": {
        "type": "string",
        "description": "Filter forms that have this status (`active`, `archived`, `trashed`, or `all`). Defaults to `active`.",
        "enum": [
          "active",
          "archived",
          "trashed",
          "all"
        ]
      },
      "type": {
        "description": "Filter forms and landing pages by type. Use `embed` for embedded forms. Use `hosted` for landing pages."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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=&lt;end_cursor&gt;`                                                                       |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                                |
| `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`. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "added_after": {
        "type": "string",
        "description": "Filter subscribers who have been added to the form after this date (format yyyy-mm-dd)"
      },
      "added_before": {
        "type": "string",
        "description": "Filter subscribers who have been added to the form before this date (format yyyy-mm-dd)"
      },
      "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)"
      },
      "form_id": {
        "type": "integer",
        "description": "Form Id"
      },
      "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"
        ]
      }
    },
    "required": [
      "PCID",
      "form_id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_posts

List posts

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                                                                                                                                     |
| --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after`               | object  | No       | —       | To fetch next page of results, use `?after=&lt;end_cursor&gt;`                                                                                                                  |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                                                                           |
| `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.                                                                                                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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_content": {
        "type": "boolean",
        "description": "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": {
        "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"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_posts\_id

Get a post

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_sequences

List sequences

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                                                                                  |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `after`               | object  | No       | —       | To fetch next page of results, use `?after=&lt;end_cursor&gt;`                                                               |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                        |
| `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.                                                                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## kit\_marketing\_get\_sequences\_id

Get a sequence

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## 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=&lt;end_cursor&gt;`                                                                       |
| `before`              | object  | No       | —       | To fetch previous page of results, use `?before=&lt;start_cursor&gt;`                                                                |
| `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`. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "added_after": {
        "type": "string",
        "description": "Filter subscribers who have been added to the form after this date (format yyyy-mm-dd)"
      },
      "added_before": {
        "type": "string",
        "description": "Filter subscribers who have been added to the form before this date (format yyyy-mm-dd)"
      },
      "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."
      },
      "sequence_id": {
        "type": "integer",
        "description": "Sequence Id"
      },
      "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"
        ]
      }
    },
    "required": [
      "PCID",
      "sequence_id"
    ]
  }
  ```
</Expandable>

***

## 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    | null     | 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    | null     | 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    | null     | No      | —                                                                                                                                                                                                                         | Thumbnail Alt                                                                                             |
| `thumbnail_url`     | string    | null     | No      | —                                                                                                                                                                                                                         | Thumbnail Url                                                                                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "content": {
        "type": "string",
        "description": "The HTML content of the email."
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "email_address": {
        "type": [
          "string",
          "null"
        ],
        "description": "The sending email address to use. Uses the account's sending email address if not provided."
      },
      "email_template_id": {
        "type": "integer",
        "description": "Id of the email template to use. Uses the account's default template if not provided. 'Starting point' template is not supported."
      },
      "preview_text": {
        "type": "string",
        "description": "Preview Text"
      },
      "public": {
        "type": "boolean",
        "description": "`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": {
        "type": "string",
        "description": "The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."
      },
      "send_at": {
        "type": [
          "string",
          "null"
        ],
        "description": "The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."
      },
      "subject": {
        "type": "string",
        "description": "The subject value"
      },
      "subscriber_filter": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "all": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`segment` or `tag`"
                  },
                  "ids": {
                    "type": "array"
                  }
                }
              },
              "description": "Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided"
            },
            "any": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`segment` or `tag`"
                  },
                  "ids": {
                    "type": "array"
                  }
                }
              },
              "description": "Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided"
            },
            "none": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`segment` or `tag`"
                  },
                  "ids": {
                    "type": "array"
                  }
                }
              },
              "description": "Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided"
            }
          },
          "required": [
            "all",
            "any",
            "none"
          ]
        },
        "description": "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": {
        "type": [
          "string",
          "null"
        ],
        "description": "Thumbnail Alt"
      },
      "thumbnail_url": {
        "type": [
          "string",
          "null"
        ],
        "description": "Thumbnail Url"
      }
    },
    "required": [
      "PCID",
      "content",
      "description",
      "preview_text",
      "public",
      "published_at",
      "subject",
      "subscriber_filter"
    ]
  }
  ```
</Expandable>

***

## 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    | null     | No      | —                   | Callback Url |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "additions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "form_id": {
              "type": "integer",
              "description": "Form Id"
            },
            "subscriber_id": {
              "type": "integer",
              "description": "Subscriber Id"
            },
            "referrer": {
              "type": "string",
              "description": "The referrer value"
            }
          },
          "required": [
            "form_id",
            "subscriber_id"
          ]
        },
        "description": "The additions value"
      },
      "callback_url": {
        "type": [
          "string",
          "null"
        ],
        "description": "Callback Url"
      }
    },
    "required": [
      "PCID",
      "additions"
    ]
  }
  ```
</Expandable>

***

## 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  | null     | No      | —             | The referrer value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "form_id": {
        "type": "integer",
        "description": "Form Id"
      },
      "email_address": {
        "type": "string",
        "description": "Email Address"
      },
      "referrer": {
        "type": [
          "string",
          "null"
        ],
        "description": "The referrer value"
      }
    },
    "required": [
      "PCID",
      "form_id",
      "email_address"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "form_id": {
        "type": "integer",
        "description": "Form Id"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "referrer": {
        "type": "string",
        "description": "The referrer value"
      }
    },
    "required": [
      "PCID",
      "form_id",
      "id",
      "referrer"
    ]
  }
  ```
</Expandable>

***

## 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.                                                                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "active": {
        "type": "boolean",
        "description": "`true` to activate the sequence, `false` to deactivate it."
      },
      "email_address": {
        "type": "string",
        "description": "The sending email address to use. Uses the account's sending email address if not provided."
      },
      "email_template_id": {
        "type": "integer",
        "description": "Id of the email template to use."
      },
      "exclude_subscriber_sources": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`."
            },
            "ids": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "description": "The ids value"
            }
          },
          "required": [
            "type",
            "ids"
          ]
        },
        "description": "The subscriber sources to exclude from the sequence."
      },
      "hold": {
        "type": "boolean",
        "description": "When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email."
      },
      "name": {
        "type": "string",
        "description": "The name of the sequence."
      },
      "repeat": {
        "type": "boolean",
        "description": "When `true`, subscribers can restart the sequence multiple times."
      },
      "send_days": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`."
      },
      "send_hour": {
        "type": "integer",
        "description": "The hour of the day to send the sequence at. Must be an integer between 0 and 23."
      },
      "time_zone": {
        "type": "string",
        "description": "The timezone to use for the sequence. Must be a valid IANA timezone string."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "sequence_id": {
        "type": "integer",
        "description": "Sequence Id"
      },
      "email_address": {
        "type": "string",
        "description": "Email Address"
      }
    },
    "required": [
      "PCID",
      "sequence_id",
      "email_address"
    ]
  }
  ```
</Expandable>

***

## 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  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "sequence_id": {
        "type": "integer",
        "description": "Sequence Id"
      }
    },
    "required": [
      "PCID",
      "id",
      "sequence_id"
    ]
  }
  ```
</Expandable>

***

## 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    | null     | 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                                                                                                                                                                                                             |                                                                                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "content": {
        "type": "string",
        "description": "The HTML content of the email."
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "email_address": {
        "type": [
          "string",
          "null"
        ],
        "description": "The sending email address to use. Uses the account's sending email address if not provided."
      },
      "email_template_id": {
        "type": "integer",
        "description": "Id of the email template to use. Uses the account's default template if not provided. 'Starting point' template is not supported."
      },
      "preview_text": {
        "type": "string",
        "description": "Preview Text"
      },
      "public": {
        "type": "boolean",
        "description": "`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": {
        "type": "string",
        "description": "The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed."
      },
      "send_at": {
        "type": "string",
        "description": "The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed."
      },
      "subject": {
        "type": "string",
        "description": "The subject value"
      },
      "subscriber_filter": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "all": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`segment` or `tag`"
                  },
                  "ids": {
                    "type": "array"
                  }
                }
              },
              "description": "Filters your subscribers using a logical AND of all provided segment and tag ids, i.e. a subscriber would have to be part of all segments and tags provided"
            },
            "any": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`segment` or `tag`"
                  },
                  "ids": {
                    "type": "array"
                  }
                }
              },
              "description": "Filters your subscribers using a logical OR of all provided segment and tag ids, i.e. a subscriber would have to be part of at least one of the segments or tags provided"
            },
            "none": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`segment` or `tag`"
                  },
                  "ids": {
                    "type": "array"
                  }
                }
              },
              "description": "Filters your subscribers using a logical NOT of all provided segment and tag ids, i.e. a subscriber would have to be in none of the segments or tags provided"
            }
          },
          "required": [
            "all",
            "any",
            "none"
          ]
        },
        "description": "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": {
        "description": "Thumbnail Alt"
      },
      "thumbnail_url": {
        "description": "Thumbnail Url"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## 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.                                                                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "active": {
        "type": "boolean",
        "description": "`true` to activate the sequence, `false` to deactivate it."
      },
      "email_address": {
        "type": "string",
        "description": "The sending email address to use. Uses the account's sending email address if not provided."
      },
      "email_template_id": {
        "type": "integer",
        "description": "Id of the email template to use."
      },
      "exclude_subscriber_sources": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`."
            },
            "ids": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "description": "The ids value"
            }
          },
          "required": [
            "type",
            "ids"
          ]
        },
        "description": "The subscriber sources to exclude from the sequence."
      },
      "hold": {
        "type": "boolean",
        "description": "When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email."
      },
      "name": {
        "type": "string",
        "description": "The name of the sequence."
      },
      "repeat": {
        "type": "boolean",
        "description": "When `true`, subscribers can restart the sequence multiple times."
      },
      "send_days": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`."
      },
      "send_hour": {
        "type": "integer",
        "description": "The hour of the day to send the sequence at. Must be an integer between 0 and 23."
      },
      "time_zone": {
        "type": "string",
        "description": "The timezone to use for the sequence. Must be a valid IANA timezone string."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>
