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

# PersistIQ API reference

> API reference for the PersistIQ plugin in Corsair: every `persistiq.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Campaigns

### addLead

`campaigns.addLead`

Add leads to a campaign; the campaign's automated emails start going to them

**Risk:** `destructive`

```ts theme={null}
await corsair.persistiq.api.campaigns.addLead({ campaignId: "c_1", lead_id: "l_1" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `string` | Yes | Campaign id |
| `lead_id` | `string` | No | Lead id to add |
| `leads` | `string[]` | No | Bulk add: up to 100 lead ids |
| `mailbox_id` | `string` | No | Mailbox to send from; defaults to the campaign owner's |
| `skip_if_exists` | `boolean` | No | Return the existing membership instead of an error |
| `override_lead_limit` | `boolean` | No | Add past the campaign's lead limit |

Starts the campaign's automated emails to the lead. Give lead\_id, or up to 100 ids in leads.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `error` | `any \| null` | No | Error details, null on success |
| `campaign_lead` | `object \| null` | No | The membership created (single add) |

> [accordion] campaign\_lead full type
>
> ```ts theme={null}
> {
>   id: string,
>   campaign_id?: string | null,
>   mailbox_id?: string | null,
>   lead?: {
>     id: string,
>     status?: string | null,
>     data?: Record<string, any> | null,
>     creator_id?: string | null,
>     owner_id?: string | null,
>     bounced?: boolean | null,
>     optedout?: boolean | null,
>     sent_count?: number | null,
>     replied_count?: number | null,
>     last_sent_at?: string | null
>   } | null
> } | null
> ```

***

### create

`campaigns.create`

Create a campaign

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.campaigns.create({ campaign_name: "Q4 outbound", owner_id: "u_1" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaign_name` | `string` | Yes | Campaign name |
| `owner_id` | `string` | Yes | User id of the campaign owner; see users.list |

campaign\_name and owner\_id (a user id from users.list) are required. The answer is the campaign itself.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | Campaign id |
| `name` | `string \| null` | No | Campaign name |
| `creator` | `object \| null` | No | The user who created the campaign |
| `stats` | `object \| null` | No | Campaign counters |

> [accordion] creator full type
>
> ```ts theme={null}
> {
>   id?: string | null,
>   name?: string | null,
>   email?: string | null
> } | null
> ```

> [accordion] stats full type
>
> ```ts theme={null}
> {
>   prospects_contacted?: number | null,
>   prospects_reached?: number | null,
>   prospects_opened?: number | null,
>   prospects_replied?: number | null,
>   prospects_bounced?: number | null,
>   prospects_optedout?: number | null,
>   total_prospects?: number | null
> } | null
> ```

***

### duplicate

`campaigns.duplicate`

Copy a campaign to a new owner

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.campaigns.duplicate({ campaign_id: "c_1", owner_id: "u_1", name: "Q4 outbound copy" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaign_id` | `string` | Yes | Campaign id to duplicate |
| `owner_id` | `string` | Yes | User id that owns the copy |
| `name` | `string` | No | Name of the copy; PersistIQ picks one when omitted |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | Campaign id |
| `name` | `string \| null` | No | Campaign name |
| `creator` | `object \| null` | No | The user who created the campaign |
| `stats` | `object \| null` | No | Campaign counters |

> [accordion] creator full type
>
> ```ts theme={null}
> {
>   id?: string | null,
>   name?: string | null,
>   email?: string | null
> } | null
> ```

> [accordion] stats full type
>
> ```ts theme={null}
> {
>   prospects_contacted?: number | null,
>   prospects_reached?: number | null,
>   prospects_opened?: number | null,
>   prospects_replied?: number | null,
>   prospects_bounced?: number | null,
>   prospects_optedout?: number | null,
>   total_prospects?: number | null
> } | null
> ```

***

### list

`campaigns.list`

List the campaigns

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.campaigns.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |
| `name` | `string` | No | Only campaigns with this name |
| `owner_id` | `string` | No | Only campaigns owned by this user id |
| `lead_id` | `string` | No | Only campaigns this lead is in |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `campaigns` | `object[]` | Yes | Campaigns |

> [accordion] campaigns full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null,
>   creator?: {
>     id?: string | null,
>     name?: string | null,
>     email?: string | null
>   } | null,
>   stats?: {
>     prospects_contacted?: number | null,
>     prospects_reached?: number | null,
>     prospects_opened?: number | null,
>     prospects_replied?: number | null,
>     prospects_bounced?: number | null,
>     prospects_optedout?: number | null,
>     total_prospects?: number | null
>   } | null
> }[]
> ```

***

### listLeads

`campaigns.listLeads`

List the leads in a campaign

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.campaigns.listLeads({ campaignId: "c_1" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `string` | Yes | Campaign id |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `campaign_leads` | `object[]` | Yes | Leads in the campaign |

> [accordion] campaign\_leads full type
>
> ```ts theme={null}
> {
>   id: string,
>   campaign_id?: string | null,
>   mailbox_id?: string | null,
>   lead?: {
>     id: string,
>     status?: string | null,
>     data?: Record<string, any> | null,
>     creator_id?: string | null,
>     owner_id?: string | null,
>     bounced?: boolean | null,
>     optedout?: boolean | null,
>     sent_count?: number | null,
>     replied_count?: number | null,
>     last_sent_at?: string | null
>   } | null
> }[]
> ```

***

### listReplies

`campaigns.listReplies`

List the replies in a campaign

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.campaigns.listReplies({ campaignId: "c_1" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `string` | Yes | Campaign id |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |
| `lead_id` | `string` | No | Only replies from this lead |
| `start_at` | `string` | No | Only replies sent on or after this ISO 8601 time |
| `end_at` | `string` | No | Only replies sent on or before this ISO 8601 time |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `replies` | `object[]` | Yes | Replies |

> [accordion] replies full type
>
> ```ts theme={null}
> {
>   id: string,
>   from_email?: string | null,
>   to_emails?: string[] | null,
>   cc_emails?: string[] | null,
>   subject?: string | null,
>   body?: string | null,
>   preview?: string | null,
>   sent_at?: string | null,
>   sentiment?: string | null,
>   kind?: string | null,
>   lead_id?: string | null,
>   campaign_id?: string | null,
>   step_message_id?: string | null
> }[]
> ```

***

### removeLead

`campaigns.removeLead`

Remove a lead from a campaign

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.campaigns.removeLead({ campaignId: "c_1", leadId: "l_1" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `string` | Yes | Campaign id |
| `leadId` | `string` | Yes | Lead id to remove (the id of the lead, as the spec names it) |

PersistIQ answers 200 with no body; the operation echoes the removed lead id.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `success` | Yes | success |
| `leadId` | `string` | Yes | The lead removed |

***

### replyToMessage

`campaigns.replyToMessage`

Reply to a message received in a campaign; the email goes out and cannot be recalled

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.persistiq.api.campaigns.replyToMessage({ campaignId: "c_1", inbox_message_id: "r_1", body: "<p>Thanks for the reply!</p>" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `string` | Yes | Campaign id |
| `inbox_message_id` | `string` | Yes | Inbox message id to reply to (a reply id from listReplies) |
| `body` | `string` | Yes | HTML body of the reply |

Queues the reply email at once; it cannot be recalled. inbox\_message\_id is a reply id from listReplies.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | queued once accepted |
| `message` | `string \| null` | No | What PersistIQ did |

***

## Dnc Domains

### create

`dncDomains.create`

Add a domain to the do-not-contact list; emails to it stop

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.dncDomains.create({ name: "example.com" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | Yes | Domain to add to the do-not-contact list, e.g. example.com |

Adds the domain to the do-not-contact list; emails to it stop. The API has no route to remove one.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `error` | `any \| null` | No | Error details, null on success |
| `dnc_domain` | `object \| null` | No | The domain added |

> [accordion] dnc\_domain full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null
> } | null
> ```

***

### list

`dncDomains.list`

List the do-not-contact domains

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.dncDomains.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `dnc_domains` | `object[]` | Yes | Do-not-contact domains |

> [accordion] dnc\_domains full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null
> }[]
> ```

***

## Events

### list

`events.list`

List activity events, with filters, page by page

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.events.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |
| `group` | `string` | No | Only events of this group |
| `campaign` | `string` | No | Only events of this campaign id |
| `lead` | `string` | No | Only events of this lead id |
| `user` | `string` | No | Only events of this user id |
| `start_at` | `string` | No | Only events after this ISO 8601 time |
| `end_at` | `string` | No | Only events before this ISO 8601 time |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `events` | `object[]` | Yes | Events on this page |

> [accordion] events full type
>
> ```ts theme={null}
> {
>   id: string,
>   event_type?: string | null,
>   data?: Record<string, any> | null,
>   created_at?: string | null
> }[]
> ```

***

## Lead Fields

### list

`leadFields.list`

List the lead field definitions

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.leadFields.list({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `lead_fields` | `object[]` | Yes | Lead field definitions |

> [accordion] lead\_fields full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null,
>   label?: string | null
> }[]
> ```

***

## Leads

### create

`leads.create`

Create a lead with its attributes

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.leads.create({ lead: { email: "john@example.com", first_name: "John" }, dup: "skip" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `lead` | `Record<string, any>` | Yes | Lead data keyed by field name (email, first\_name, last\_name, company\_name, ...); see leadFields.list |
| `dup` | `update \| skip` | No | What to do when a lead with the same email exists |
| `creator_id` | `string` | No | User id recorded as the creator |

The lead fields go in `lead`; dup "skip" or "update" handles an existing email. The answer is \{ status, error, lead }.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `error` | `any \| null` | No | Error details, null on success |
| `lead` | `object` | Yes | The lead |

> [accordion] lead full type
>
> ```ts theme={null}
> {
>   id: string,
>   status?: string | null,
>   data?: Record<string, any> | null,
>   creator_id?: string | null,
>   owner_id?: string | null,
>   bounced?: boolean | null,
>   optedout?: boolean | null,
>   sent_count?: number | null,
>   replied_count?: number | null,
>   last_sent_at?: string | null
> }
> ```

***

### get

`leads.get`

Read one lead by id

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.leads.get({ id: "l_1" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | Lead id, or the lead email address |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `error` | `any \| null` | No | Error details, null on success |
| `lead` | `object` | Yes | The lead |

> [accordion] lead full type
>
> ```ts theme={null}
> {
>   id: string,
>   status?: string | null,
>   data?: Record<string, any> | null,
>   creator_id?: string | null,
>   owner_id?: string | null,
>   bounced?: boolean | null,
>   optedout?: boolean | null,
>   sent_count?: number | null,
>   replied_count?: number | null,
>   last_sent_at?: string | null
> }
> ```

***

### list

`leads.list`

List leads, with filters, page by page

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.leads.list({ page: 1, updated_after: "2025-11-01T00:00:00Z" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |
| `status` | `string` | No | Only leads with this status name |
| `status_id` | `string` | No | Only leads with this status id |
| `updated_after` | `string` | No | Only leads updated after this ISO 8601 time |
| `created_after` | `string` | No | Only leads created after this ISO 8601 time |
| `email` | `string` | No | Only the lead with this email |

Numbered pages: pass page 2, 3, ... while has\_more is true. Filters: status, status\_id, updated\_after, created\_after, email.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `leads` | `object[]` | Yes | Leads on this page |

> [accordion] leads full type
>
> ```ts theme={null}
> {
>   id: string,
>   status?: string | null,
>   data?: Record<string, any> | null,
>   creator_id?: string | null,
>   owner_id?: string | null,
>   bounced?: boolean | null,
>   optedout?: boolean | null,
>   sent_count?: number | null,
>   replied_count?: number | null,
>   last_sent_at?: string | null
> }[]
> ```

***

### update

`leads.update`

Update a lead's status, owner, flags or attributes

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.leads.update({ id: "l_1", status: "Replied", data: { first_name: "Jane" } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | Lead id, or the lead email address |
| `status` | `string` | No | New status name |
| `status_id` | `string` | No | New status id |
| `owner_id` | `string` | No | New owner user id |
| `bounced` | `boolean` | No | Mark the lead bounced |
| `optedout` | `boolean` | No | Mark the lead opted out |
| `data` | `Record<string, any>` | No | Lead attributes to update, keyed by field name |

Changes status, owner, bounced/optedout flags and the data attributes; keys come from leadFields.list.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `error` | `any \| null` | No | Error details, null on success |
| `lead` | `object` | Yes | The lead |

> [accordion] lead full type
>
> ```ts theme={null}
> {
>   id: string,
>   status?: string | null,
>   data?: Record<string, any> | null,
>   creator_id?: string | null,
>   owner_id?: string | null,
>   bounced?: boolean | null,
>   optedout?: boolean | null,
>   sent_count?: number | null,
>   replied_count?: number | null,
>   last_sent_at?: string | null
> }
> ```

***

## Lead Statuses

### list

`leadStatuses.list`

List the lead status vocabulary

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.leadStatuses.list({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `lead_statuses` | `object[]` | Yes | Lead statuses |

> [accordion] lead\_statuses full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null
> }[]
> ```

***

## Tags

### list

`tags.list`

List the tags

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.tags.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `tags` | `object[]` | Yes | Tags |

> [accordion] tags full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null
> }[]
> ```

***

## Users

### list

`users.list`

List the team members

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.users.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | Page number, from 1; ask for the next one while has\_more is true |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | success or error |
| `errors` | `string[] \| null` | No | Problems PersistIQ reports with the request |
| `has_more` | `boolean \| null` | No | Whether more pages exist |
| `next_page` | `string \| null` | No | Link to the next page; pass page + 1 to fetch it |
| `users` | `object[]` | Yes | Team members |

> [accordion] users full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string | null,
>   email?: string | null,
>   activated?: boolean | null,
>   salesforce_id?: string | null,
>   default_mailbox_id?: string | null,
>   mailboxes?: {
>     id?: string | null,
>     email?: string | null,
>     campaign_ids?: string[] | null
>   }[] | null
> }[]
> ```

***

## Webhooks

### getSettings

`webhooks.getSettings`

Read the webhook plugin settings

**Risk:** `read`

```ts theme={null}
await corsair.persistiq.api.webhooks.getSettings({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `post_new_prospect` | `boolean \| null` | No | Whether new-lead deliveries are on |
| `post_new_prospect_url` | `string \| null` | No | Endpoint new-lead deliveries are posted to |
| `post_updated_prospect` | `boolean \| null` | No | Whether updated-lead deliveries are on |
| `post_updated_prospect_url` | `string \| null` | No | Endpoint updated-lead deliveries are posted to |
| `raw_events` | `boolean \| null` | No | Whether raw-event deliveries are on |
| `raw_events_url` | `string \| null` | No | Endpoint raw-event deliveries are posted to |
| `post_email_reply` | `boolean \| null` | No | Whether email-reply deliveries are on |
| `post_email_reply_url` | `string \| null` | No | Endpoint email-reply deliveries are posted to |
| `post_email_opened` | `boolean \| null` | No | Whether email-opened deliveries are on |
| `post_email_opened_url` | `string \| null` | No | Endpoint email-opened deliveries are posted to |

***

### updateSettings

`webhooks.updateSettings`

Turn webhook deliveries on or off and set the URL each one posts to

**Risk:** `write`

```ts theme={null}
await corsair.persistiq.api.webhooks.updateSettings({ post_new_prospect: true, post_new_prospect_url: "https://example.com/webhooks/persistiq" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `post_new_prospect` | `boolean` | No | Turn new-lead deliveries on or off |
| `post_new_prospect_url` | `string` | No | Endpoint new-lead deliveries are posted to |
| `post_updated_prospect` | `boolean` | No | Turn updated-lead deliveries on or off |
| `post_updated_prospect_url` | `string` | No | Endpoint updated-lead deliveries are posted to |
| `raw_events` | `boolean` | No | Turn raw-event deliveries on or off |
| `raw_events_url` | `string` | No | Endpoint raw-event deliveries are posted to |
| `post_email_reply` | `boolean` | No | Turn email-reply deliveries on or off |
| `post_email_reply_url` | `string` | No | Endpoint email-reply deliveries are posted to |
| `post_email_opened` | `boolean` | No | Turn email-opened deliveries on or off |
| `post_email_opened_url` | `string` | No | Endpoint email-opened deliveries are posted to |

Each delivery type (new lead, updated lead, raw events, email reply, email opened) has its own on/off flag and URL.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `post_new_prospect` | `boolean \| null` | No | Whether new-lead deliveries are on |
| `post_new_prospect_url` | `string \| null` | No | Endpoint new-lead deliveries are posted to |
| `post_updated_prospect` | `boolean \| null` | No | Whether updated-lead deliveries are on |
| `post_updated_prospect_url` | `string \| null` | No | Endpoint updated-lead deliveries are posted to |
| `raw_events` | `boolean \| null` | No | Whether raw-event deliveries are on |
| `raw_events_url` | `string \| null` | No | Endpoint raw-event deliveries are posted to |
| `post_email_reply` | `boolean \| null` | No | Whether email-reply deliveries are on |
| `post_email_reply_url` | `string \| null` | No | Endpoint email-reply deliveries are posted to |
| `post_email_opened` | `boolean \| null` | No | Whether email-opened deliveries are on |
| `post_email_opened_url` | `string \| null` | No | Endpoint email-opened deliveries are posted to |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.