reference.md

# Reference
## AbTests
<details><summary><code>$client-&gt;abTests-&gt;addVariant($abTestId, $request) -> ?AddVariantAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds a variant to a draft campaign or sequence A/B test. Sequence variants receive an independent email template. The body defaults to the control email when blocks are omitted. Sequence tests whose parent sequence is active require confirmLiveChange.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->addVariant(
    'abTestId',
    new AddVariantAbTestsRequest([
        'subject' => 'subject',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` — Variant body blocks. Defaults to the campaign or sequence control email blocks.
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Required as true when the A/B test belongs to an active sequence, because new variants immediately enter the live rotation.
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` — Variant preview text.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `string` — Variant subject line.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;create($request) -> ?CreateAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a draft campaign A/B test or converts a sequence email node to action_ab_test. Provide exactly one owner. Variant A is copied into an independent email for sequences; sequence conversions require at least one extra variant.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->create(
    new CreateAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$automationNodeId:** `?string` — Sequence action_email node to convert. Mutually exclusive with campaignId.
    
</dd>
</dl>

<dl>
<dd>

**$campaignId:** `?string` — Campaign to attach the test to. Must be in draft or rejected status. Mutually exclusive with automationNodeId.
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Must be true when converting an email node in an active sequence.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Test name. Defaults to "A/B Test for <campaign name>".
    
</dd>
</dl>

<dl>
<dd>

**$testDurationMinutes:** `?int` — Campaign-only duration before winner selection. Sequence tests select after winnerThreshold recipients, once one variant leads on human opens or clicks.
    
</dd>
</dl>

<dl>
<dd>

**$testPercentage:** `?int` — Campaign-only share of the audience that receives test sends. Sequence tests use winnerThreshold.
    
</dd>
</dl>

<dl>
<dd>

**$testType:** `?string` — Sequence variant strategy. Subject defaults to open_rate and content defaults to click_rate unless winnerCriteria is explicit.
    
</dd>
</dl>

<dl>
<dd>

**$variants:** `?array` — Extra variants beyond the control. Required (min 1) when converting with automationNodeId. Total variants cannot exceed 5.
    
</dd>
</dl>

<dl>
<dd>

**$winnerCriteria:** `?string` — Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default.
    
</dd>
</dl>

<dl>
<dd>

**$winnerThreshold:** `?int` — Number of sequence recipients in the test sample.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;delete($abTestId) -> ?DeleteAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a campaign A/B test and its variants. Running tests cannot be deleted, and the linked campaign must be in draft or rejected status.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->delete(
    'abTestId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;deleteVariant($abTestId, $variantId, $request) -> ?DeleteVariantAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes a variant from a draft campaign or sequence A/B test. The control variant A cannot be deleted, and at least 2 variants must remain. Deleting a sequence variant also deletes its dedicated email template; sequence tests whose parent sequence is active require confirmLiveChange.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->deleteVariant(
    'abTestId',
    'variantId',
    new DeleteVariantAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>

<dl>
<dd>

**$variantId:** `string` — Variant ID.
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Required as true when the A/B test belongs to an active sequence, because deletion immediately changes the live rotation.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;get($abTestId) -> ?GetAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one A/B test with variants and variant localization status.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->get(
    'abTestId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;getStats($abTestId, $request) -> ?GetStatsAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns aggregate and per-variant engagement stats for an A/B test, plus the statistical significance of the test's winner metric.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->getStats(
    'abTestId',
    new GetStatsAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — Custom range end. Requires start.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Optional period filter.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Custom range start. Requires end.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;list($request) -> ?ListAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists A/B tests and variants for the authenticated company, optionally filtered by sequence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->list(
    new ListAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `?string` — Optional sequence ID filter for automation A/B tests.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;restart($abTestId, $request) -> ?RestartAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Starts a new draft sequence A/B test from the selected control variant after a winner has been selected. The new test becomes active after generated variants are ready.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->restart(
    'abTestId',
    new RestartAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID to restart.
    
</dd>
</dl>

<dl>
<dd>

**$sourceVariantId:** `?string` — Variant ID to use as the new control email. Defaults to the selected winner.
    
</dd>
</dl>

<dl>
<dd>

**$testType:** `?string` — Test type for generated variants.
    
</dd>
</dl>

<dl>
<dd>

**$variantCount:** `?int` — Total variants including the control.
    
</dd>
</dl>

<dl>
<dd>

**$winnerThreshold:** `?int` — Subscribers before selecting a winner.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;resume($abTestId, $request) -> ?ResumeAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Clears the winner of a sequence A/B test so contacts reaching the step are split across its variants again, keeping the results collected so far. Automatic winner selection is turned off for the test, so it keeps splitting until a winner is selected. Requires the sequences:write scope and, while the sequence is active, confirmLiveChange.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->resume(
    'abTestId',
    new ResumeAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Required as true when the sequence is active.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;selectWinner($abTestId, $request) -> ?SelectWinnerAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Selects a winner for a campaign A/B test in the testing phase and queues the winning variant for the remaining audience. For a sequence A/B test, selects or changes the winner that future contacts reaching the step receive, including a winner picked automatically; contacts who already got a variant keep it. Campaign tests require the campaigns:send scope; sequence tests require sequences:write and, while the sequence is active, confirmLiveChange.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->selectWinner(
    'abTestId',
    new SelectWinnerAbTestsRequest([
        'variantId' => 'variantId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Sequence tests only. Required as true when the sequence is active. Campaign tests ignore it.
    
</dd>
</dl>

<dl>
<dd>

**$variantId:** `string` — Variant to select as the winner.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;update($abTestId, $request) -> ?UpdateAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a draft or testing campaign test or the effective settings for a sequence test. Live campaign duration is measured from its original start; sample changes are asynchronous and preserve committed recipients. Campaigns use testPercentage and testDurationMinutes; sequences use testType and winnerThreshold. Sequence changes that affect a live or already-used test require confirmLiveChange.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->update(
    'abTestId',
    new UpdateAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>

<dl>
<dd>

**$autoSelectWinner:** `?bool` — Sequence-only. True picks the leading variant once winnerThreshold is reached; false keeps splitting until a winner is selected. Resume sets it to false.
    
</dd>
</dl>

<dl>
<dd>

**$cancelSampleUpdate:** `?bool` — Discard a failed campaign sample request. Cannot be combined with testPercentage; does not undo committed sends.
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Required when sequence settings affect an active test or a test with recorded activity.
    
</dd>
</dl>

<dl>
<dd>

**$expectedUpdatedAt:** `?DateTime` — Optional campaign revision from GET; stale values return 409. Omit to preserve existing unconditional update behavior.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$testDurationMinutes:** `?int` — Campaign-only total minutes from the original test start. An elapsed deadline queues selection immediately; paused campaigns stay paused.
    
</dd>
</dl>

<dl>
<dd>

**$testPercentage:** `?int` — Campaign-only integer share of the original full audience. Live changes queue a durable request; repeat the same percentage to retry.
    
</dd>
</dl>

<dl>
<dd>

**$testType:** `?string` — Sequence-only variant strategy.
    
</dd>
</dl>

<dl>
<dd>

**$winnerCriteria:** `?string` — Winner metric for campaign or sequence tests; immutable once campaign testing starts.
    
</dd>
</dl>

<dl>
<dd>

**$winnerThreshold:** `?int` — Sequence-only recipient threshold.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;abTests-&gt;updateVariant($abTestId, $variantId, $request) -> ?UpdateVariantAbTestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an A/B test variant's subject, preview text, or body content. Campaign variants remain editable only while the test is in draft. Sequence variants can be edited later with confirmLiveChange when the sequence is active, the test is no longer a draft, or the test has recorded activity; earlier sends remain unchanged, so combined results may no longer be accurate.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->abTests->updateVariant(
    'abTestId',
    'variantId',
    new UpdateVariantAbTestsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$abTestId:** `string` — A/B test ID.
    
</dd>
</dl>

<dl>
<dd>

**$variantId:** `string` — Variant ID.
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Required as true when the sequence is active, the test is no longer a draft, or the test has recorded activity. Earlier sends remain unchanged, so combined results may no longer be accurate.
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Account
<details><summary><code>$client-&gt;account-&gt;createApiKey($request) -> ?CreateApiKeyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a company-scoped API key. The caller must have the `api_keys:manage` permission. Account-scoped keys select the target company with the x-company-id header; companyId in the JSON body is not a supported selector. The plain key is returned only once.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->createApiKey(
    new CreateApiKeyRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$name:** `?string` — Human-readable key name.
    
</dd>
</dl>

<dl>
<dd>

**$preset:** `?string` — Permission preset to apply when scopes is omitted. Defaults to full_access. Full-access keys are stored with scopes set to null, meaning all current and future permissions.
    
</dd>
</dl>

<dl>
<dd>

**$scopes:** `?array` — Explicit permission scopes for the new key. Overrides preset when provided.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;account-&gt;get() -> ?GetAccountResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the companies available to the authenticated API key, the currently selected company, and a read-only summary of the key's own permissions.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->get();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;account-&gt;getIntegrationGuide($request) -> ?GetIntegrationGuideResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a framework-specific code example and implementation tip for common integration use cases.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->getIntegrationGuide(
    new GetIntegrationGuideRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$framework:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$useCase:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;account-&gt;listApiKeys() -> ?ListApiKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists company-scoped API keys as non-secret metadata. The caller must have the `api_keys:manage` permission. Account-scoped keys select the company with the x-company-id header. Plain key values and stored hashes are never returned.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->listApiKeys();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;account-&gt;requestApiKeyHandoff($request) -> ?RequestApiKeyHandoffResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Builds a dashboard link that opens the create-key form prefilled with a suggested name and permissions. Requires only `account:read`, because it creates nothing, changes nothing, and returns no secret - the new key is issued in the owner's authenticated browser session. Use it when key management is blocked because the calling key lacks `api_keys:manage`, which cannot be granted through the API by the key that is missing it. Pass replaceApiKeyId to rotate; the dashboard then offers to revoke the predecessor once the replacement exists.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->requestApiKeyHandoff(
    new RequestApiKeyHandoffRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$name:** `?string` — Suggested name for the new key. Trimmed to 80 characters in the link.
    
</dd>
</dl>

<dl>
<dd>

**$preset:** `?string` — Suggested permission preset.
    
</dd>
</dl>

<dl>
<dd>

**$replaceApiKeyId:** `?string` — ID of the key the new one replaces. Pass the literal string "current" for the key making the request.
    
</dd>
</dl>

<dl>
<dd>

**$scopes:** `?array` — Suggested explicit permission scopes. Overrides preset when provided.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;account-&gt;revokeApiKey($apiKeyId) -> ?RevokeApiKeyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently revokes a company-scoped API key. The caller must have the `api_keys:manage` permission. The response contains non-secret metadata only.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->revokeApiKey(
    'apiKeyId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$apiKeyId:** `string` — Exact API key ID returned by the list API keys endpoint.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;account-&gt;updateApiKey($apiKeyId, $request) -> ?UpdateApiKeyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Renames a company-scoped API key and/or replaces its permissions in place. The caller must have the `api_keys:manage` permission. The key value is unchanged. Added permissions apply on the next retry; removed permissions may remain usable for up to five minutes while API caches expire. `preset` and `scopes` replace the whole selection rather than merging into it. The response contains non-secret metadata only.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->account->updateApiKey(
    'apiKeyId',
    new UpdateApiKeyRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$apiKeyId:** `string` — Exact API key ID returned by the list API keys endpoint.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — New human-readable key name.
    
</dd>
</dl>

<dl>
<dd>

**$preset:** `?string` — Replacement permission preset. Full-access keys are stored with scopes set to null, meaning all current and future permissions.
    
</dd>
</dl>

<dl>
<dd>

**$scopes:** `?array` — Replacement explicit permission scopes. Overrides preset when provided.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Accounts
<details><summary><code>$client-&gt;accounts-&gt;acceptSuggestions($request) -> ?AccountSuggestionsAcceptResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an account for each domain (external ID and domain set to the domain, name derived from it) and adds the domain's contacts that belong to no account as members. When one account already uses the domain as its domain or external ID, contacts are added to it instead; with several, the domain is skipped (`multiple_accounts`). A domain whose contacts already partly belong to another account is skipped (`already_in_account`) so an organization is not duplicated. Domains without eligible contacts are skipped (`no_contacts`). Existing roles, names and domains are kept, no sync rules run, segment-entered sequences are not triggered, and retries are safe. Accounts hold at most 5,000 members, the attribute fan-out limit; `truncated` reports contacts left out.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->acceptSuggestions(
    new AcceptSuggestionsAccountsRequest([
        'domains' => [
            'domains',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domains:** `array` — Domains to accept, such as `acme.com`. Normalized to lowercase; duplicates are ignored. Personal and disposable providers are rejected.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;addMember($externalIdPathParam, $request) -> ?AccountMemberChangeResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds a contact to the account (creating the contact when `email` is new). Re-adding an existing member with a role updates it; without a role keeps the current one.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->addMember(
    'externalId',
    new AddMemberAccountsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalIdPathParam:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Contact external ID, as an alternative to email.
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$role:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;createFromOrganizationId($request) -> ?CreateFromOrganizationIdAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Starts a background job that creates one account per distinct value of `propertyKey` and adds each contact seen with that value as a `member`. Accounts are named from `nameKey` when set, otherwise after the work email domain most of their contacts share; existing names, domains and roles are kept. No emails are sent, no sync rules run and segment-entered sequences are not triggered. A run already queued or running for the same key is returned with `alreadyRunning` set instead of starting another; its `job.settings` show the source and name key it uses. Reruns are safe. Accounts is turned on before the job is queued and stays on even if the job fails.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->createFromOrganizationId(
    new AccountOrganizationIdKey([
        'propertyKey' => 'propertyKey',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$nameKey:** `?string` — Property or attribute holding the organization name. Without it, accounts are named after the work email domain their contacts share.
    
</dd>
</dl>

<dl>
<dd>

**$propertyKey:** `string` — Event property or contact attribute holding your organization ID, such as `workspaceId`. Trimmed.
    
</dd>
</dl>

<dl>
<dd>

**$source:** `?string` — Where the ID lives.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;delete($externalId) -> ?DeleteAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes the account and its memberships. Contacts are kept; their `account.*` attributes are cleared.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->delete(
    'externalId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — Customer-owned organization ID (URL-encode slashes).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;detectOrganizationIds() -> ?DetectOrganizationIdsAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Finds event properties from the last 180 days (such as `workspaceId` or `organization_id`) and contact attributes (such as `account_id`) that look like your own organization ID, so you can create accounts from data you already send. Most useful first. Read-only; preview a candidate before creating accounts from it.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->detectOrganizationIds();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;getByExternalId($externalId) -> ?GetByExternalIdAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the account and up to 100 members, owners first.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->getByExternalId(
    'externalId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — Customer-owned organization ID (URL-encode slashes).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;getOrganizationIdJob($jobId) -> ?GetOrganizationIdJobAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Reports a job started by `POST /account-suggestions/organization-ids`. Finished jobs are kept for a limited time, after which this returns 404; the accounts stay.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->getOrganizationIdJob(
    'jobId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$jobId:** `string` — The `jobId` returned when the job started, URL-encoded.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;list($request) -> ?ListAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->list(
    new ListAccountsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$order:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$sort:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;listEvents($externalId, $request) -> ?ListEventsAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Recent events recorded on the account timeline, newest first (maximum 500).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->listEvents(
    'externalId',
    new ListEventsAccountsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;listMembers($externalId, $request) -> ?ListMembersAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the contacts that belong to the account with their role. Owners first, then admins, then members.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->listMembers(
    'externalId',
    new ListMembersAccountsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;listSuggestions($request) -> ?ListSuggestionsAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Suggests accounts from work email domains that several contacts share, with up to 10 sample emails each. Personal and disposable providers (gmail.com, outlook.com, yopmail.com, ...), the workspace's own sending domains and their subdomains, domains where any contact already belongs to an account, and domains an account already uses (as its domain or external ID) are skipped. Largest domains first. Read-only; nothing is created until you accept a suggestion.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->listSuggestions(
    new ListSuggestionsAccountsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` — Number of suggestions. Values outside 1-100 are clamped; non-numeric values use the default.
    
</dd>
</dl>

<dl>
<dd>

**$minContacts:** `?int` — Contacts a domain needs to be suggested. Values outside 2-1000 are clamped; non-numeric values use the default.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;previewFromOrganizationId($request) -> ?PreviewFromOrganizationIdAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Shows the biggest organizations that creating accounts from `propertyKey` would make, with the name each account would get and sample contacts. Read-only.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->previewFromOrganizationId(
    new PreviewFromOrganizationIdAccountsRequest([
        'propertyKey' => 'propertyKey',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` — Organizations to return. Values outside 1-50 are clamped; non-numeric values use the default.
    
</dd>
</dl>

<dl>
<dd>

**$nameKey:** `?string` — Property or attribute holding the organization name.
    
</dd>
</dl>

<dl>
<dd>

**$propertyKey:** `string` — Event property or contact attribute holding your organization ID.
    
</dd>
</dl>

<dl>
<dd>

**$source:** `?string` — Where the ID lives.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;removeMember($externalIdPathParam, $request) -> ?RemoveMemberAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes a contact from the account. The contact is kept; its `account.*` attributes are cleared or replaced by another account it belongs to.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->removeMember(
    'externalId',
    new RemoveMemberAccountsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalIdPathParam:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;triggerEvent($externalId, $request) -> ?TriggerEventAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Records an event on the account timeline and delivers it as a contact event to the chosen recipients (`owners` by default, falling back to admins when there is no owner; `admins` includes owners; `all` every member; `none` records only). Each delivery runs the normal event pipeline with `event.account.*` properties. Pass `eventId` to make retries idempotent. Retries reuse the original recipients and event data, skip completed deliveries, and resume failed work without duplicating events or sequence enrollments.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->triggerEvent(
    'externalId',
    new TriggerEventAccountsRequest([
        'event' => 'trial_ending',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$event:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$eventId:** `?string` — Idempotency key scoped to this account, including when accounts share members. Retries keep the original recipients, properties and event time and resume incomplete deliveries.
    
</dd>
</dl>

<dl>
<dd>

**$occurredAt:** `?DateTime` 
    
</dd>
</dl>

<dl>
<dd>

**$properties:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$recipients:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;update($externalId, $request) -> ?UpdateAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates name, domain and attributes of an existing account. Returns 404 when the account does not exist.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->update(
    'externalId',
    new AccountPatchInput([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — Customer-owned organization ID (URL-encode slashes).
    
</dd>
</dl>

<dl>
<dd>

**$attributes:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$domain:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$replaceAttributes:** `?bool` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;accounts-&gt;upsert($request) -> ?AccountUpsertResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Upserts an account by its customer-owned externalId. Attributes merge into the stored attributes (null deletes a key; replaceAttributes replaces them all). Optional members are added in the same call. Account attributes fan out to every member for segments and `{{account.*}}` merge tags.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->accounts->upsert(
    new AccountUpsertInput([
        'externalId' => 'org_123',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$attributes:** `?array` — Up to 100 attributes. Null values delete keys when merging.
    
</dd>
</dl>

<dl>
<dd>

**$domain:** `?string` — Normalized to a hostname such as acme.com.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$members:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$replaceAttributes:** `?bool` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Analytics
<details><summary><code>$client-&gt;analytics-&gt;getCampaignEmailClientMetrics($campaignId, $request) -> ?GetCampaignEmailClientMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the mail clients and device types that opened a campaign, as shares of its unique opens. Each email send counts once, attributed to the client of its first open. Covers the whole campaign.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getCampaignEmailClientMetrics(
    'campaignId',
    new GetCampaignEmailClientMetricsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Email campaign ID.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset opens.
    
</dd>
</dl>

<dl>
<dd>

**$mailboxProvider:** `?string` — Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getCampaignMetrics($campaignId, $request) -> ?GetCampaignMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns aggregated engagement metrics, attached campaign-goal results, a lifetime per-link click breakdown, and lifetime Poll/NPS summaries for a specific campaign. Clicked links and poll summaries are not limited by period/start/end.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getCampaignMetrics(
    'campaignId',
    new GetCampaignMetricsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$mailboxProvider:** `?string` — Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies, conversions, and revenue as 0 because those metrics cannot be segmented per provider.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when `start` and `end` are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getCampaignStatsLegacy($campaignId, $request) -> ?GetCampaignStatsLegacyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Backward-compatible alias for `GET /metrics/campaigns/{campaignId}`. Returns aggregated engagement metrics, attached campaign-goal results, a lifetime per-link click breakdown, and lifetime Poll/NPS summaries for a specific campaign.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getCampaignStatsLegacy(
    'campaignId',
    new GetCampaignStatsLegacyRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$mailboxProvider:** `?string` — Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies, conversions, and revenue as 0 because those metrics cannot be segmented per provider.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when `start` and `end` are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getEmailClientMetrics($request) -> ?GetEmailClientMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the mail clients and device types that opened your emails, as shares of unique opens. Each email send counts once, attributed to the client of its first open. Defaults to the last 90 days.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getEmailClientMetrics(
    new GetEmailClientMetricsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailType:** `?string` — Structural email type filter. Marketer-role personal keys see campaign and sequence email only and cannot request transactional.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset opens.
    
</dd>
</dl>

<dl>
<dd>

**$mailboxProvider:** `?string` — Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud).
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding window over open times. Ignored when start/end are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getMetrics($request) -> ?GetMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns aggregated email engagement metrics for the specified time period, plus live subscriberCount (every stored contact) and activeSubscriberCount (status=active) as an audience snapshot independent of period. Set emailType=transactional for Send API and transactional SMTP traffic.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getMetrics(
    new GetMetricsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailType:** `?string` — Structural email type filter. Use transactional for Send API and transactional SMTP traffic.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$mailboxProvider:** `?string` — Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies as 0 (replies cannot be segmented per provider) and omit the commerce forecast.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when start/end are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getRecipients($request) -> ?GetRecipientsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getRecipients(
    new GetRecipientsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `?string` — Filter to recipients of a specific campaign
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Filter to a single recipient by email address
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events in recipient engagement arrays.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Recipients per page (max 100)
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when start/end are provided.
    
</dd>
</dl>

<dl>
<dd>

**$sequenceId:** `?string` — Filter to recipients of a specific sequence
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getSequenceMetrics($sequenceId, $request) -> ?GetSequenceMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns aggregated engagement metrics plus a live active/waiting enrollment breakdown by current node for a specific sequence (automation).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getSequenceMetrics(
    'sequenceId',
    new GetSequenceMetricsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence (automation) ID
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when `start` and `end` are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getStatsLegacy($request) -> ?GetStatsLegacyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Backward-compatible alias for `GET /metrics`. Returns aggregated email engagement metrics for the specified time period and supports the same emailType filter.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getStatsLegacy(
    new GetStatsLegacyRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailType:** `?string` — Structural email type filter. Use transactional for Send API and transactional SMTP traffic.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$mailboxProvider:** `?string` — Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies as 0 (replies cannot be segmented per provider) and omit the commerce forecast.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when start/end are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getTransactionalMetrics($idOrSlug, $request) -> ?TransactionalMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns aggregate engagement metrics for one saved transactional email selected by ID or slug. Results are all-time unless a period or custom range is supplied.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getTransactionalMetrics(
    'idOrSlug',
    new GetTransactionalMetricsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$idOrSlug:** `string` — Saved transactional email ID or API slug.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — Custom range end. Must be used with start; maximum 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Optional sliding time window. Ignored when start/end are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Custom range start. Must be used with end.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;getTransactionalMetricsLegacy($idOrSlug, $request) -> ?TransactionalMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Backward-compatible alias for `GET /metrics/transactional/{idOrSlug}`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->getTransactionalMetricsLegacy(
    'idOrSlug',
    new GetTransactionalMetricsLegacyRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$idOrSlug:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` 
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;listCampaignEvents($campaignId, $request) -> ?ListCampaignEventsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns paginated raw email events for a specific campaign. Defaults to delivery events.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->listCampaignEvents(
    'campaignId',
    new ListCampaignEventsRequest([
        'eventTypes' => 'delivery,click',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$eventType:** `?string` — Single event type to include. Defaults to delivery when no event type filter is provided.
    
</dd>
</dl>

<dl>
<dd>

**$eventTypes:** `?string` — Comma-separated event types to include. Supported values are send, delivery, bounce, complaint, open, click, unsubscribe, delivery_delay, and transport_failure.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events when requesting engagement event types.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Events per page (max 500)
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when `start` and `end` are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;listCampaignPollResponses($campaignId, $request) -> ?ListCampaignPollResponsesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->listCampaignPollResponses(
    'campaignId',
    new ListCampaignPollResponsesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID, or the automation node ID of a sequence email step
    
</dd>
</dl>

<dl>
<dd>

**$blockId:** `?string` — Restrict results to one poll block. Block IDs come from the `polls` array of the campaign metrics endpoint.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Responses per page (max 500)
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;listCampaignPollResponsesLegacy($campaignId, $request) -> ?ListCampaignPollResponsesLegacyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Alias for `GET /metrics/campaigns/{campaignId}/poll-responses`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->listCampaignPollResponsesLegacy(
    'campaignId',
    new ListCampaignPollResponsesLegacyRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID, or the automation node ID of a sequence email step
    
</dd>
</dl>

<dl>
<dd>

**$blockId:** `?string` — Restrict results to one poll block.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Responses per page (max 500)
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;listEmailMetrics($request) -> ?ListEmailMetricsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one row per email - each campaign and each sequence email step - with its own delivery funnel, attributed conversions, and revenue. Sequence rows carry sequenceId, automationNodeId, and the step number, so cross-sequence questions such as how many step-4 emails went out are one request instead of one per sequence. Counts come from retained event storage and match the steps array of the sequence metrics endpoint. The totals object covers every matching email rather than the current page.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->listEmailMetrics(
    new ListEmailMetricsRequest([
        'campaignId' => 'camp_abc123,camp_def456',
        'sequenceId' => 'seq_abc123,seq_def456',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `?string` — Comma-separated campaign IDs to restrict the breakdown to. Cannot be combined with sequenceId, step, or emailType=sequence.
    
</dd>
</dl>

<dl>
<dd>

**$emailType:** `?string` — Restrict to campaigns or sequence emails. Defaults to both. Implied as sequence when sequenceId or step is set, and as campaign when campaignId is set.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events in engagement metrics.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Emails per page.
    
</dd>
</dl>

<dl>
<dd>

**$order:** `?string` — Sort order.
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when start/end are provided. Omit both for all-time counts.
    
</dd>
</dl>

<dl>
<dd>

**$sequenceId:** `?string` — Comma-separated sequence IDs to restrict the breakdown to. Cannot be combined with campaignId or emailType=campaign.
    
</dd>
</dl>

<dl>
<dd>

**$sort:** `?string` — Sort field.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>

<dl>
<dd>

**$step:** `?int` — Keep only sequence emails at this 1-based position, counted in graph order per sequence. Cannot be combined with emailType=campaign.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;analytics-&gt;listSequenceEvents($sequenceId, $request) -> ?ListSequenceEventsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns paginated raw email events for every email step in a sequence, or for one step via automationNodeId. Defaults to delivery events. This is the per-recipient stream; for per-step totals read the steps array of the sequence metrics endpoint or GET /metrics/emails.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->analytics->listSequenceEvents(
    'sequenceId',
    new ListSequenceEventsRequest([
        'eventTypes' => 'delivery,open,click',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence (automation) ID
    
</dd>
</dl>

<dl>
<dd>

**$automationNodeId:** `?string` — Scope the stream to one email step of this sequence. Take the node ID from the steps array of the sequence metrics endpoint. A node that is not an email step of this sequence returns 400.
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$eventType:** `?string` — Single event type to include. Defaults to delivery when no event type filter is provided.
    
</dd>
</dl>

<dl>
<dd>

**$eventTypes:** `?string` — Comma-separated event types to include. Supported values are send, delivery, bounce, complaint, open, click, unsubscribe, delivery_delay, and transport_failure.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events when requesting engagement event types.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Events per page (max 500)
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when `start` and `end` are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## AudienceSyncs
<details><summary><code>$client-&gt;audienceSyncs-&gt;create($request) -> ?CreateAudienceSyncsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Pushes a segment to a Meta custom audience and keeps it synced on a schedule. Provide segmentId for an existing segment or predefinedSegmentId for a ready-made template (for example zero-ltv, no-purchase-1y, recent-buyers); template segments are created automatically on first use. The first upload runs immediately. Audiences are add-only - subscribers who later leave the segment stay in the Meta audience. Requires the Meta Ads integration to be connected in the dashboard.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->audienceSyncs->create(
    [
        'key' => "value",
    ],
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$request:** `mixed` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;audienceSyncs-&gt;delete($syncId) -> ?DeleteAudienceSyncsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes the sync mapping. The Meta audience itself is kept so running ads are not disrupted - only future syncs stop.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->audienceSyncs->delete(
    'syncId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$syncId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;audienceSyncs-&gt;list() -> ?ListAudienceSyncsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists segment-to-Meta-audience syncs with schedule and last sync status.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->audienceSyncs->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;audienceSyncs-&gt;listAdAccounts() -> ?ListAdAccountsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the Meta ad accounts reachable through the connected Meta Ads integration.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->audienceSyncs->listAdAccounts();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;audienceSyncs-&gt;runNow($syncId) -> ?RunNowAudienceSyncsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Triggers an immediate upload outside the regular schedule. The sync must be active.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->audienceSyncs->runNow(
    'syncId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$syncId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;audienceSyncs-&gt;update($syncId, $request) -> ?UpdateAudienceSyncsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Changes an audience sync's frequency or pauses/resumes it.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->audienceSyncs->update(
    'syncId',
    new UpdateAudienceSyncsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$syncId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$isActive:** `?bool` — false pauses the sync, true resumes it.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Campaigns
<details><summary><code>$client-&gt;campaigns-&gt;cancel($campaignId) -> ?CancelCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Cancels a sending, paused, scheduled, waiting_approval, or rejected campaign and removes any pending send jobs.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->cancel(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;check($campaignId, $request) -> ?CheckEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Run the pre-send email check on a saved campaign: the same rules as the editor's email checker, plus live verification of every link and image, including links in every A/B variant and translation unless variantId or locale pins one version. Read-only: this never sends or modifies anything, and uses POST only so personalization input can travel in a request body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->check(
    'campaignId',
    new CheckCampaignsRequest([
        'body' => new CheckEmailRequest([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$request:** `CheckEmailRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;create($request) -> ?CreateCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a campaign and linked email from at most one of prompt, HTML, Sequenzy blocks, or an existing template. Omit all content sources to create an empty draft. Optional From/Reply-To inputs create or select profiles; From addresses require a verified sending domain. Defaults to draft. Use status `sent` only to archive an imported/already-sent campaign. Marketer account keys must choose existing sender and Reply-To profiles; requests requiring new profiles return 400 before creating profiles, labels, or campaign/sequence changes, including nested steps and branches.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->create(
    new CreateCampaignsRequest([
        'html' => '<p>Hello there!</p>',
        'labels' => [
            'edm',
            'api',
        ],
        'name' => 'April Launch',
        'preheaderText' => 'A short preview for the inbox',
        'subject' => 'A quick update',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$blocks:** `?array` — Sequenzy email blocks. Mutually exclusive with html. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.
    
</dd>
</dl>

<dl>
<dd>

**$campaignData:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$computedLists:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$emailPreset:** `?string` — Per-email Style > Format for native Sequenzy blocks. This is separate from the prompt-generation `style` field. Cannot be combined with `html`, and a template or blocks payload stored as one standalone raw HTML block does not support it. Applying `minimal` removes standalone logo blocks; switching back to `branded` generates a new logo unless the authored logo block is sent again.
    
</dd>
</dl>

<dl>
<dd>

**$fromEmail:** `?string` — Campaign From address. Its domain must be configured and verified.
    
</dd>
</dl>

<dl>
<dd>

**$fromName:** `?string` — Display name recipients see, e.g. 'Brennon at TradeTally'. Selects the sender identity of that name on fromEmail, creating it when the address has no identity by that name; the mailbox's other display names, and everything pinned to them, are untouched. Requires fromEmail; omit it when using senderProfileId, which already carries its own display name.
    
</dd>
</dl>

<dl>
<dd>

**$html:** `?string` — Raw HTML body. Mutually exclusive with blocks.
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?array` — Compatibility alias for labels.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Label names to assign. Missing labels are created automatically.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Shorthand for targeting one or more lists. Equivalent to `targetLists` `{"type":"lists","listIds":["list_123"]}`. Mutually exclusive with targetLists and segmentId.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$preheaderText:** `?string` — Compatibility alias for previewText.
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` — Optional inbox preview text saved on the linked email.
    
</dd>
</dl>

<dl>
<dd>

**$prompt:** `?string` — Natural-language request for branded native campaign blocks.
    
</dd>
</dl>

<dl>
<dd>

**$replyProfileId:** `?string` — Existing reply profile ID. It already supplies both the Reply-To address and display name, so send it on its own and omit replyTo and replyToName.
    
</dd>
</dl>

<dl>
<dd>

**$replyTo:** `?string` — Campaign Reply-To address. A reply profile is created when needed.
    
</dd>
</dl>

<dl>
<dd>

**$replyToName:** `?string` — Display name for the Reply-To address. Requires replyTo; omit it when using replyProfileId, which already carries its own display name. An address carries one Reply-To name company-wide, so if replyTo already has a saved profile under a different name, that saved name is kept and the response `warnings` array says so.
    
</dd>
</dl>

<dl>
<dd>

**$segmentId:** `?string` — Shorthand for targeting one saved segment. Equivalent to `targetLists` `{"type":"segment","segmentId":"seg_123"}`. Mutually exclusive with targetLists and listIds.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName.
    
</dd>
</dl>

<dl>
<dd>

**$sentAt:** `?DateTime` — ISO date-time for an imported/already-sent campaign. Only valid with status sent; defaults to now when omitted.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Initial status. Defaults to draft. Use sent only for imported/already-sent campaigns.
    
</dd>
</dl>

<dl>
<dd>

**$style:** `?string` — Generation style; valid only with prompt. Pass designed or plain to force the designed or plain-text email style; other values are freeform prompt guidance. Defaults to the company's email style preference.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Required with HTML, blocks, or templateId; optional with prompt, where it overrides the generated subject.
    
</dd>
</dl>

<dl>
<dd>

**$targetLists:** `?array` — Campaign audience saved on the draft. Omit to leave targeting unset and choose it when scheduling. The object is a union discriminated on type: {"type":"all"}, {"type":"lists","listIds":["list_123"]}, {"type":"segment","segmentId":"seg_123"}, {"type":"filtered","filters":[],"filterJoinOperator":"and"}, {"type":"rules","include":[],"exclude":[]}. Mutually exclusive with segmentId and listIds.
    
</dd>
</dl>

<dl>
<dd>

**$templateId:** `?string` — Company-owned email template to copy into the campaign. Mutually exclusive with prompt, HTML, and blocks. The content snapshot of a code-managed transactional email (created by sends with `trackAs`) is rejected with 400, because it holds one recipient's real content.
    
</dd>
</dl>

<dl>
<dd>

**$tone:** `?string` — Generation tone; valid only with prompt.
    
</dd>
</dl>

<dl>
<dd>

**$trackingCode:** `?string` — Optional campaign tracking code available to UTM templates as `{{campaign.trackingCode}}`. Empty strings are stored as null.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;createForAudience($request) -> ?CreateForAudienceCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a blank draft and freezes distinct contacts from a complete contact selection or email-activity drilldown. Requires campaigns:write and subscribers:read, plus analytics:read for activity. Maximum 100,000 contacts and 8 MiB stored audience JSON. No sending domain or send permission is required for drafting. Membership is saved now; active status and email eligibility are checked again at send time. Deleted historical analytics contacts are omitted. Read, replace or clear targetLists using the existing campaign endpoints.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->createForAudience(
    new CreateForAudienceCampaignsRequest([
        'selection' => new CreateForAudienceCampaignsRequestSelection([
            'source' => CreateForAudienceCampaignsRequestSelectionSource::Contacts->value,
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$selection:** `CreateForAudienceCampaignsRequestSelection` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;createGoal($campaignId, $request) -> ?CreateGoalCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an event, subscriber-attribute, or tag-applied conversion goal on one email campaign. SMS campaigns are not supported. The attribution window defaults to 168 hours when omitted.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->createGoal(
    'campaignId',
    new CreateGoalCampaignsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;createShareLink($campaignId) -> ?CreateShareLinkCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates (or fetches) the campaign's public view-in-browser link. The hosted page renders an anonymized copy - sample contact, inert unsubscribe link, no open/click tracking - so the URL is safe to forward to anyone. Idempotent - an already-active link is returned with created=false instead of being rotated. Email campaigns only.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->createShareLink(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;delete($campaignId) -> ?DeleteCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently deletes a campaign. Active campaigns (sending, scheduled, or paused) must be cancelled first.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->delete(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;deleteGoal($campaignId, $goalId) -> ?DeleteGoalCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently removes a conversion goal from the campaign.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->deleteGoal(
    'campaignId',
    'goalId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$goalId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;duplicate($campaignId, $request) -> ?DuplicateCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a draft copy of a campaign. Optionally copies the campaign's A/B test or duplicates a single variant as a plain campaign.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->duplicate(
    'campaignId',
    new DuplicateCampaignsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$mode:** `?string` — campaign copies the campaign email, ab_test also copies the linked A/B test and variants, variant copies one variant's content as a plain campaign.
    
</dd>
</dl>

<dl>
<dd>

**$variantId:** `?string` — Variant ID to copy. Required when mode is variant.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;get($campaignId) -> ?GetCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one campaign with its email blocks, campaign data, reply-to profile, and schedule timestamps. Poll this to follow a campaign held in waiting_approval: on approval the status returns to scheduled (or sending, if the scheduled time already passed), and on rejection it becomes rejected with reviewer feedback in rejectionComment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->get(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;getAudience($campaignId) -> ?GetAudienceCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Resolves the campaign's stored targeting into named lists and segments and returns a recipient count computed at read time. When audience.isUnset is true the campaign has no targeting and scheduling sends to every active subscriber.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->getAudience(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;list($request) -> ?ListCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists campaigns for the authenticated company, optionally filtered by status or label. Each item includes delivery pacing (sendTimeOptimization, sendTimeWindowHours, spreadOverHours, sendInRecipientTimezone, scheduledTimezone) and the recipient cap (maxRecipients) so a company-wide STO audit does not need one getCampaign call each. STO is campaign-only; sequences use sendingWindow.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->list(
    new ListCampaignsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$label:** `?string` — Optional label name filter. Only campaigns assigned this label are returned.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Optional page size. Values above 100 are capped to 100.
    
</dd>
</dl>

<dl>
<dd>

**$offset:** `?int` — Optional zero-based row offset.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Optional campaign status filter.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;listGoals($campaignId) -> ?ListGoalsCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists campaign-specific goals in goals and automatically applied Settings goals in companyGoals. Both include inactive goals. Company-wide goals keep their open/click attribution window and are managed in Settings. SMS campaigns are not supported.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->listGoals(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;pause($campaignId) -> ?PauseCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Pauses a campaign that is currently sending. In-progress chunk workers stop and remaining recipients are held until resume.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->pause(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;previewComputedData($campaignId, $request) -> ?PreviewComputedDataCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Preview the per-recipient lists that a campaign computes from campaign data.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->previewComputedData(
    'campaignId',
    new PreviewComputedDataCampaignsRequest([
        'subscriber' => new PreviewComputedDataCampaignsRequestSubscriber([
            'customAttributes' => [
                'interests' => [
                    "theatre",
                    "arts",
                ],
                'region' => "Auckland",
            ],
            'email' => 'anna@example.com',
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$subscriber:** `?PreviewComputedDataCampaignsRequestSubscriber` — Inline subscriber preview data.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Existing subscriber ID to use for preview.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;render($campaignId, $request) -> ?RenderEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Render a campaign to the exact email-safe HTML that would be sent, for embedding a visual preview. Read-only: this never sends or modifies anything, and uses POST only so personalization input can travel in a request body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->render(
    'campaignId',
    new RenderCampaignsRequest([
        'body' => new RenderEmailRequest([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$request:** `RenderEmailRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;resendToNonOpeners($campaignId) -> ?ResendToNonOpenersCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a draft that resends a sent campaign to everyone in the same audience who didn't open it. Reuses the original audience plus a "didn't open this campaign" rule. Only available 6 hours after the campaign finishes sending, and never for imported already-sent campaigns, which have no opens in Sequenzy. The draft must be scheduled or sent separately. Every audience format stores excludedCampaignOpenerIds that manual additions cannot override, preserving inherited exclusions on repeated resends. Audience membership is evaluated live. Recreate older drafts missing this metadata from the original campaign and review before scheduling.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->resendToNonOpeners(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;resume($campaignId, $request) -> ?ResumeCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Resumes a paused campaign. Sending continues with remaining recipients, including A/B test phases when the campaign has a linked test.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->resume(
    'campaignId',
    new ResumeCampaignsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$spreadOverHours:** `?int` — Spread remaining delivery over this many hours. Pass null to clear an existing spread.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;revokeShareLink($campaignId) -> ?RevokeShareLinkCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Revokes the campaign's public view-in-browser link. The shared URL returns 404 immediately; sharing again later mints a different URL. Returns revoked=false when no link was active.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->revokeShareLink(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;schedule($campaignId, $request) -> ?ScheduleCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Schedules a draft or already scheduled campaign for a future send time. Requires a verified sending domain. Campaigns that require safety review are held in waiting_approval and scheduled after a reviewer approves them. A waiting_approval result is a normal 200 outcome and is most common on new accounts and recently registered sending domains; retrying the schedule call does not clear the hold, so branch on campaign.status and poll GET /campaigns/{campaignId} instead. See https://docs.sequenzy.com/concepts/campaigns#safety-review
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->schedule(
    'campaignId',
    new ScheduleCampaignsRequest([
        'scheduledAt' => new DateTime('2024-01-15T09:30:00Z'),
        'targetLists' => [
            'type' => "all",
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Shorthand for sending to one or more lists. Equivalent to `targetLists` `{"type":"lists","listIds":["list_123"]}`. Mutually exclusive with targetLists.
    
</dd>
</dl>

<dl>
<dd>

**$maxRecipients:** `?int` — Send to at most this many audience members. The first N matching subscribers (by subscriber id) receive the campaign after every audience and suppression rule is applied; recipients already reached count against the cap when a paused send resumes. Omit to keep the draft's saved cap, send null to clear it. The response's estimatedRecipientCount reflects the cap. For A/B tests, the cap must be at least the number of variants plus one; a smaller saved or requested cap returns 400 without changing the campaign or schedule.
    
</dd>
</dl>

<dl>
<dd>

**$recurringInterval:** `?string` — Repeat the campaign on a cadence starting at scheduledAt. The campaign becomes a recurring template - each run is duplicated and sent automatically, re-evaluating audience membership every time. Omit or send null for a one-shot send; scheduling again without it stops the recurrence.
    
</dd>
</dl>

<dl>
<dd>

**$scheduledAt:** `DateTime` — Future send time.
    
</dd>
</dl>

<dl>
<dd>

**$scheduledTimezone:** `?string` — IANA timezone the scheduledAt wall-clock time refers to, for example America/New_York. Required with sendInRecipientTimezone.
    
</dd>
</dl>

<dl>
<dd>

**$sendInRecipientTimezone:** `?bool` — Deliver at scheduledAt's wall-clock time in each recipient's own timezone. Requires scheduledTimezone. Contacts without a stored timezone receive the campaign at scheduledAt itself. Not combinable with recurringInterval or spreadOverHours. Omitting it on a reschedule preserves the campaign's existing setting; send false to turn it off.
    
</dd>
</dl>

<dl>
<dd>

**$sendTimeOptimization:** `?bool` — Deliver each recipient at their predicted best open hour within sendTimeWindowHours of scheduledAt (default 12h, max 24). Campaign-only: there is no company or sequence STO toggle. Sequences use sendingWindow instead. spreadOverHours takes precedence and turns STO off; sendInRecipientTimezone also turns it off.
    
</dd>
</dl>

<dl>
<dd>

**$sendTimeWindowHours:** `?int` — STO delivery window in hours from scheduledAt. Defaults to 12. Only used when sendTimeOptimization is true. Recipients whose predicted hour falls outside the window are snapped to the nearest edge.
    
</dd>
</dl>

<dl>
<dd>

**$spreadOverHours:** `?float` — Spread delivery over this many hours. When set, spread delivery takes precedence over send-time optimization.
    
</dd>
</dl>

<dl>
<dd>

**$targetLists:** `?array` — Optional targeting object. Omit to reuse saved targeting - or, when none is saved, ALL active subscribers. The object is a union discriminated on type: {"type":"all"}, {"type":"lists","listIds":["list_123"]}, {"type":"segment","segmentId":"seg_123"}, {"type":"filtered","filters":[],"filterJoinOperator":"and"}, {"type":"rules","include":[],"exclude":[]}. Mutually exclusive with listIds.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;sendTest($campaignId, $request) -> ?SendTestCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a test send for a campaign and returns a durable email send ID for delivery-status inspection.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->sendTest(
    'campaignId',
    new SendTestCampaignsRequest([
        'to' => 'to',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$to:** `string` — Test recipient email address.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;unschedule($campaignId) -> ?UnscheduleCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes the pending send for a scheduled campaign and returns it to an editable draft. Recurrence is stopped, and the campaign can be edited and scheduled again.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->unschedule(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;update($campaignId, $request) -> ?UpdateCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a draft campaign's name, labels, content, audience, From/Reply-To settings, campaign personalization data, or delivery pacing (sendTimeOptimization and sendTimeWindowHours). Direct addresses create profiles when needed. Send Time Optimization is campaign-only; sequences use sendingWindow. Marketer account keys must choose existing sender and Reply-To profiles; requests requiring new profiles return 400 before creating profiles, labels, or campaign/sequence changes, including nested steps and branches.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->update(
    'campaignId',
    new UpdateCampaignsRequest([
        'subject' => 'A quick update',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Campaign ID
    
</dd>
</dl>

<dl>
<dd>

**$bccEmails:** `?array` — Addresses BCC'd on every recipient's email for this campaign. Send an empty array or null to clear them.
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` — Updated Sequenzy email blocks. Mutually exclusive with `html`. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.
    
</dd>
</dl>

<dl>
<dd>

**$campaignData:** `?array` — Campaign-scoped JSON data available while rendering this campaign. Top-level arrays can contain up to 500 items. Set to null to clear it.
    
</dd>
</dl>

<dl>
<dd>

**$ccEmails:** `?array` — Addresses CC'd on every recipient's email for this campaign. Send an empty array or null to clear them.
    
</dd>
</dl>

<dl>
<dd>

**$computedLists:** `?array` — Personalized list definitions computed from campaignData. Keys can use letters, numbers, underscores, and dots. Use maxItems to cap each subscriber's list length. Pass an empty array to clear computed lists.
    
</dd>
</dl>

<dl>
<dd>

**$emailPreset:** `?string` — Change the linked email's Style > Format without rewriting its copy. Supported only for native Sequenzy blocks and cannot be combined with `html`. An email stored as one standalone raw HTML block does not support it. Applying `minimal` removes standalone logo blocks; switching back to `branded` generates a new logo unless the authored logo block is sent again.
    
</dd>
</dl>

<dl>
<dd>

**$fromEmail:** `?string` — Campaign From address. Its domain must be configured and verified.
    
</dd>
</dl>

<dl>
<dd>

**$fromName:** `?string` — Display name recipients see, e.g. 'Brennon at TradeTally'. Selects the sender identity of that name on fromEmail, creating it when the address has no identity by that name; the mailbox's other display names, and everything pinned to them, are untouched. Requires fromEmail; omit it when using senderProfileId, which already carries its own display name.
    
</dd>
</dl>

<dl>
<dd>

**$html:** `?string` — Updated email HTML content. Mutually exclusive with `blocks`.
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?array` — Compatibility alias for labels.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Replacement label names. Send an empty array to clear labels. Missing labels are created automatically.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Shorthand for retargeting the draft at one or more lists. Equivalent to `targetLists` `{"type":"lists","listIds":["list_123"]}`. Mutually exclusive with targetLists and segmentId.
    
</dd>
</dl>

<dl>
<dd>

**$maxRecipients:** `?int` — Send to at most this many audience members. The first N matching subscribers (by subscriber id) receive the campaign after every audience and suppression rule is applied. Persists on the draft until schedule overrides it. Send null to remove the limit. Values outside 1-10,000,000 are rejected with 400.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Updated campaign name
    
</dd>
</dl>

<dl>
<dd>

**$preheaderText:** `?string` — Compatibility alias for previewText.
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` — Updated inbox preview text. Set to null to clear it.
    
</dd>
</dl>

<dl>
<dd>

**$replyProfileId:** `?string` — Reply profile ID for this company. It already supplies both the Reply-To address and display name, so send it on its own and omit replyTo and replyToName.
    
</dd>
</dl>

<dl>
<dd>

**$replyTo:** `?string` — Reply-To email for this campaign. A profile is created when needed. Mutually exclusive with `replyProfileId`.
    
</dd>
</dl>

<dl>
<dd>

**$replyToName:** `?string` — Display name for the Reply-To address. Requires replyTo; omit it when using replyProfileId, which already carries its own display name. An address carries one Reply-To name company-wide, so if replyTo already has a saved profile under a different name, that saved name is kept and the response `warnings` array says so.
    
</dd>
</dl>

<dl>
<dd>

**$segmentId:** `?string` — Shorthand for retargeting the draft at one saved segment. Equivalent to `targetLists` `{"type":"segment","segmentId":"seg_123"}`. Mutually exclusive with targetLists and listIds.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName.
    
</dd>
</dl>

<dl>
<dd>

**$sendTimeOptimization:** `?bool` — Deliver each recipient at their predicted best open hour within sendTimeWindowHours of scheduledAt. Campaign-only: there is no company or sequence STO toggle. Sequences use sendingWindow instead. Persists on the draft until schedule overrides it. spreadOverHours and sendInRecipientTimezone each turn STO off.
    
</dd>
</dl>

<dl>
<dd>

**$sendTimeWindowHours:** `?int` — STO delivery window in hours from scheduledAt. Defaults to 12. Only used when sendTimeOptimization is true.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Updated email subject line
    
</dd>
</dl>

<dl>
<dd>

**$targetLists:** `?array` — Replacement campaign audience, using the same shapes as campaign create, e.g. {"type":"lists","listIds":["list_123"]}. Send null to clear saved targeting and choose the audience when scheduling; omit to leave it unchanged. Mutually exclusive with segmentId and listIds.
    
</dd>
</dl>

<dl>
<dd>

**$trackingCode:** `?string` — Campaign tracking code available to UTM templates as `{{campaign.trackingCode}}`. Send an empty string or null to clear it.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;campaigns-&gt;updateGoal($campaignId, $goalId, $request) -> ?UpdateGoalCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replaces the editable configuration for an existing email-campaign goal. SMS campaigns are not supported.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->campaigns->updateGoal(
    'campaignId',
    'goalId',
    new UpdateGoalCampaignsRequest([
        'body' => new CampaignGoalInput([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$goalId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$request:** `CampaignGoalInput` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Companies
<details><summary><code>$client-&gt;companies-&gt;create($request) -> ?CreateCompaniesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a company workspace, optionally without a website, and can queue the onboarding welcome sequence. Requires a personal account key (seq_user_...). Company-scoped keys (seq_live_... and legacy ek_... keys) are bound to a single company and are rejected with 403, because they could never access the workspace they created.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->companies->create(
    new CreateCompaniesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$description:** `?string` — Optional business description used as context for welcome-sequence generation. Without a website, a non-null value that is not a string of up to 500 characters returns 400; with a domain it is ignored, and website processing may replace the stored description.
    
</dd>
</dl>

<dl>
<dd>

**$domain:** `?string` — Company website domain or URL. Required unless noWebsite is true. When both are sent, the domain is used.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Company display name. If omitted, Sequenzy derives it from the domain.
    
</dd>
</dl>

<dl>
<dd>

**$noWebsite:** `?bool` — Create a ready workspace without a website. Requires name when no domain is sent. Ignored when a non-blank domain is sent.
    
</dd>
</dl>

<dl>
<dd>

**$withWelcomeSequence:** `?bool` — Set true to create a draft four-email welcome sequence and queue its generation. Defaults to false; any other value is treated as false.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;companies-&gt;get($companyId) -> ?GetCompaniesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one company workspace that the authenticated key can access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->companies->get(
    'companyId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyId:** `string` — Company ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;companies-&gt;list() -> ?ListCompaniesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists companies available to the authenticated API key.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->companies->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;companies-&gt;update($companyId, $request) -> ?UpdateCompaniesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates product info, brand context, the default email theme, reply-tracking settings, the workspace default lists, and account-wide From/Reply-To defaults. New profiles are created as needed; From addresses require a verified sending domain. Requires the company_profile:manage scope; the sending-identity, reply-tracking, and defaultSubscriberListIds fields additionally require companies:manage.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->companies->update(
    'companyId',
    new UpdateCompaniesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyId:** `string` — Company ID
    
</dd>
</dl>

<dl>
<dd>

**$address:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$brandColors:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$companyContext:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$defaultSubscriberListIds:** `?array` — Which lists new contacts join when something creates a subscriber without explicit list targeting - forms, API writes, events, tag actions, imports, and any integration without its own list targeting. null means every current and future list, [] means no list at all, and an array means exactly those lists. Unknown or foreign list IDs are rejected rather than skipped. Applies only to later writes; nobody is moved or removed retroactively. Requires the companies:manage scope.
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$emailDesignPrompt:** `?string` — Art direction for AI-designed emails: layout, density, which sections belong in an email, imagery, and CTA prominence. `toneVoice` steers copy; this steers design. When empty, the next email generation prefills it with the direction derived from the brand; null clears it so the next generation writes a fresh one.
    
</dd>
</dl>

<dl>
<dd>

**$emailDirection:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$emailLengthPreference:** `?string` — How long AI-written email copy should be. New workspaces default to `concise`.
    
</dd>
</dl>

<dl>
<dd>

**$emailTheme:** `?UpdateCompaniesRequestEmailTheme` — Default email theme. Partial update - omitted fields keep their current value (or the preset default) and numeric values are clamped to supported ranges. Pass null to reset to the platform default theme.
    
</dd>
</dl>

<dl>
<dd>

**$fontFamily:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$forwardReplies:** `?bool` — Enable or disable forwarding captured replies to the configured mailbox.
    
</dd>
</dl>

<dl>
<dd>

**$founderName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$fromEmail:** `?string` — Account-wide default From address. The domain must be configured and verified.
    
</dd>
</dl>

<dl>
<dd>

**$fromName:** `?string` — Display name of the default From profile. Sent on its own it renames the current default profile; with senderProfileId it renames that profile; with fromEmail it names the profile for that address. If the address already carries several display names, the request is rejected - pass senderProfileId to say which one to rename.
    
</dd>
</dl>

<dl>
<dd>

**$language:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$logoUrl:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$previousCompanyName:** `?string` — Required when renameMatchingFooters is true. Current company name from GET company. A stale name returns 409; retrying a completed rename does not repeat footer changes.
    
</dd>
</dl>

<dl>
<dd>

**$pricing:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$primaryColor:** `?string` — 6-digit hex color, for example
    
</dd>
</dl>

<dl>
<dd>

**$privacyPolicyUrl:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$renameMatchingFooters:** `?bool` — With name and previousCompanyName, atomically rename exact matching footer company names in editable emails and saved components. Preserves custom names, body copy, sent or sending campaigns and active A/B tests. Null is not accepted. This option additionally requires emails:write, templates:write, campaigns:write, sequences:write, transactional:write and ab_tests:write; personal keys require owner/admin access.
    
</dd>
</dl>

<dl>
<dd>

**$replyProfileId:** `?string` — Existing reply profile to make the account-wide default, and the profile replyToName renames. Mutually exclusive with replyTo.
    
</dd>
</dl>

<dl>
<dd>

**$replyTo:** `?string` — Account-wide default Reply-To address. A reply profile is created when needed.
    
</dd>
</dl>

<dl>
<dd>

**$replyToName:** `?string` — Display name of the default Reply-To profile. Sent on its own it renames the current default profile; with replyProfileId it renames that profile; with replyTo it names the profile for that address.
    
</dd>
</dl>

<dl>
<dd>

**$replyTrackingDomainMode:** `?string` — Use Sequenzy's managed inbound domain or a configured custom domain.
    
</dd>
</dl>

<dl>
<dd>

**$replyTrackingEnabled:** `?bool` — Enable or disable inbound reply capture.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Existing sender profile to make the account-wide default, and the profile fromName renames. List IDs with GET /v1/sender-profiles. Mutually exclusive with fromEmail.
    
</dd>
</dl>

<dl>
<dd>

**$socialLinks:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$termsUrl:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$testimonials:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$toneVoice:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$valueProps:** `?array` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Conversations
<details><summary><code>$client-&gt;conversations-&gt;bulkUpdateStatus($request) -> ?BulkUpdateStatusConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Opens or closes up to 100 conversations in one request. Only conversations whose status changes are updated, so retries are safe. IDs that do not exist in the company are reported in `notFoundIds` and do not fail the request.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->bulkUpdateStatus(
    new BulkUpdateStatusConversationsRequest([
        'conversationIds' => [
            'conversationIds',
        ],
        'status' => BulkUpdateStatusConversationsRequestStatus::Open->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationIds:** `array` — Conversation IDs to update, up to 100. Whitespace is trimmed and blank or repeated IDs are ignored; at least one non-blank ID is required.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `string` — New status for every listed conversation.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;forwardMessage($conversationId, $messageId, $request) -> ?ForwardMessageConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Emails a copy of one received or sent message, with its stored attachments up to 15 MB in total (files left out are listed in the forwarded email), to another address. The forward is recorded in the conversation as a system message whose deliveryStatus moves from pending to sent or failed. It does not change the conversation's status, unread state, or last activity. Notes cannot be forwarded.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->forwardMessage(
    'conversationId',
    'messageId',
    new ForwardMessageConversationsRequest([
        'to' => 'to',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationId:** `string` — Conversation ID.
    
</dd>
</dl>

<dl>
<dd>

**$messageId:** `string` — ID of the message to forward.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Sender profile to forward from. Its sending domain must be verified. When omitted, the company default sender is used.
    
</dd>
</dl>

<dl>
<dd>

**$to:** `string` — One email address to forward the message to.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;get($conversationId) -> ?GetConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one conversation with all messages, originating campaign or sequence context, and subscriber details. Stored attachments include a signed downloadUrl valid for one hour.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->get(
    'conversationId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationId:** `string` — Conversation ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;getInboxAddress() -> ?GetInboxAddressResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the address anyone can email to reach this company's inbox, the same address on verified custom inbound domains, whether receiving is on, whether attachments are stored, and how long received email is kept.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->getInboxAddress();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;list($request) -> ?ListConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists inbox conversations: replies to your campaigns, sequences, and transactional email, plus email sent to your inbox address. Filter by status, unread flag, or search term.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->list(
    new ListConversationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` — Results per page.
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number.
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` — Search in subject, subscriber email, or subscriber name.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Filter by conversation status.
    
</dd>
</dl>

<dl>
<dd>

**$unread:** `?string` — Pass "true" to only return conversations with unread messages.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;markRead($conversationId) -> ?MarkReadConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Marks all unread inbound messages in a conversation as read and clears the unread flag.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->markRead(
    'conversationId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationId:** `string` — Conversation ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;markUnread($conversationId) -> ?MarkUnreadConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sets the conversation's unread flag and marks its latest received message unread.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->markUnread(
    'conversationId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationId:** `string` — Conversation ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;sendMessage($conversationId, $request) -> ?SendMessageConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sends an email reply to the subscriber or adds an internal note. Replies reopen closed conversations.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->sendMessage(
    'conversationId',
    new SendMessageConversationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationId:** `string` — Conversation ID.
    
</dd>
</dl>

<dl>
<dd>

**$attachments:** `?array` — Files to attach, up to 10 and 15 MB total after decoding. Requires attachment storage on the server (see Get Inbox Address).
    
</dd>
</dl>

<dl>
<dd>

**$bodyHtml:** `?string` — HTML body. Outbound messages require bodyText or bodyHtml.
    
</dd>
</dl>

<dl>
<dd>

**$bodyText:** `?string` — Plain text body. Outbound messages require bodyText or bodyHtml.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Sender profile to send an outbound reply from. Its sending domain must be verified. Ignored for notes. When omitted, the reply is sent from the API key owner's email address, which must be on one of your verified sending domains.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Message subject. Defaults to the conversation subject.
    
</dd>
</dl>

<dl>
<dd>

**$type:** `?string` — outbound sends an email reply, note adds an internal team note.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;updateInboxAddress($request) -> ?UpdateInboxAddressResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sets a branded inbox address `{localPart}@inbound.{domain}` on one of your verified sending domains, or clears it when both fields are null. The address starts receiving once the domain's inbound MX record is verified; the default address keeps working. Returns the same body as Get Inbox Address.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->updateInboxAddress(
    new UpdateInboxAddressRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `?string` — A verified sending domain of the company, such as `acme.com`. Null to clear.
    
</dd>
</dl>

<dl>
<dd>

**$localPart:** `?string` — Name before the @, such as `support`. Letters, numbers, dots, dashes and underscores, starting and ending with a letter or number. Stored in lowercase. Null to clear.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;conversations-&gt;updateStatus($conversationId, $request) -> ?UpdateStatusConversationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Opens or closes a conversation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->conversations->updateStatus(
    'conversationId',
    new UpdateStatusConversationsRequest([
        'status' => UpdateStatusConversationsRequestStatus::Open->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$conversationId:** `string` — Conversation ID.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `string` — New conversation status.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Data Exports
<details><summary><code>$client-&gt;dataExports-&gt;createDataExport($request) -> ?CreateDataExportResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds an S3, Google Cloud Storage or S3-compatible bucket as a data export destination. Sequenzy first writes a small test file under the path prefix; the request fails with 400 when that write fails. The first export starts immediately and later exports follow the frequency. Requires data_exports:write, subscribers:read and analytics:read.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->createDataExport(
    new CreateDataExportRequest([
        'accessKeyId' => 'accessKeyId',
        'bucket' => 'bucket',
        'name' => 'name',
        'provider' => CreateDataExportRequestProvider::S3->value,
        'secretAccessKey' => 'secretAccessKey',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$accessKeyId:** `string` — Access key ID (GCS HMAC access ID).
    
</dd>
</dl>

<dl>
<dd>

**$bucket:** `string` — Bucket name, not a URL.
    
</dd>
</dl>

<dl>
<dd>

**$datasets:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$endpoint:** `?string` — HTTPS origin of an S3-compatible service (R2, MinIO, Backblaze). Must resolve to a public address. Not allowed for gcs.
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$pathPrefix:** `?string` — Folder inside the bucket. Leading and trailing slashes are removed.
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `string` — s3 for Amazon S3 or any S3-compatible service; gcs for Google Cloud Storage (HMAC keys).
    
</dd>
</dl>

<dl>
<dd>

**$region:** `?string` — Bucket region. Required for Amazon S3 without a custom endpoint; defaults to auto otherwise.
    
</dd>
</dl>

<dl>
<dd>

**$secretAccessKey:** `string` — Secret access key. Stored encrypted and never returned.
    
</dd>
</dl>

<dl>
<dd>

**$startFrom:** `?DateTime` — Include events recorded since this time, at most 30 days ago. Defaults to now.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;deleteDataExport($id) -> ?DeleteDataExportResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Stops exporting to the destination and deletes its run history. Files already written stay in the bucket.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->deleteDataExport(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;getDataExport($id) -> ?GetDataExportResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one data export with status and per-dataset progress.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->getDataExport(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;listDataExportRuns($id, $request) -> ?ListDataExportRunsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists recent runs from the last 14 days, newest first.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->listDataExportRuns(
    'id',
    new ListDataExportRunsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;listDataExports() -> ?ListDataExportsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists data export destinations with status, per-dataset progress and the last error. Credentials are never returned. Requires the data_exports:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->listDataExports();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;runDataExport($id) -> ?RunDataExportResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues an export immediately instead of waiting for the schedule. If a run is already queued or running, no second run starts.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->runDataExport(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;testDataExport($id) -> ?TestDataExportResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Writes a small test file with the stored credentials.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->testDataExport(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;dataExports-&gt;updateDataExport($id, $request) -> ?UpdateDataExportResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Renames, changes datasets or frequency, pauses or resumes, moves the destination, or rotates credentials. Location and credential changes are verified with a test write first. Newly added event datasets start from the time of the change. Changing the bucket or prefix continues from the current progress in the new location.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->dataExports->updateDataExport(
    'id',
    new UpdateDataExportRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$accessKeyId:** `?string` — Must be sent together with secretAccessKey.
    
</dd>
</dl>

<dl>
<dd>

**$bucket:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$datasets:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$endpoint:** `?string` — Send null or an empty string to clear a custom endpoint.
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$isEnabled:** `?bool` — false pauses the export, true resumes it.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$pathPrefix:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$region:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$secretAccessKey:** `?string` — Must be sent together with accessKeyId.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## EmailAiStyle
<details><summary><code>$client-&gt;emailAiStyle-&gt;clearEmailAiStyle($request) -> ?EmailAiStyleState</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires emails:write. Clears only the reviewed revision. Future generations use normal brand defaults; existing emails stay unchanged. Replayed or stale clears return 409.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailAiStyle->clearEmailAiStyle(
    new ClearEmailAiStyleRequest([
        'expectedStyleId' => 'expectedStyleId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$expectedStyleId:** `string` — Nonempty revisionId returned by GET, including unsupported-version revisions.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailAiStyle-&gt;getEmailAiStyle() -> ?EmailAiStyleState</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires emails:read. Returns the saved appearance and its revision. Read and review this state before replacing or clearing it.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailAiStyle->getEmailAiStyle();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailAiStyle-&gt;saveEmailAiStyle($request) -> ?EmailAiStyleState</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires emails:write and access to the source email. Snapshots the stored email appearance, using email then company theme and font defaults, or the optional unsaved canvas, plus detected layout habits such as dotted dividers around every button. Existing emails and company theme remain unchanged. Marketers cannot capture transactional sources. Replaces only the expected revision; explicit generation style requests and plain-text choices still take precedence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailAiStyle->saveEmailAiStyle(
    new SaveEmailAiStyleRequest([
        'emailId' => 'emailId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$canvas:** `?EmailAiStyleCanvas` 
    
</dd>
</dl>

<dl>
<dd>

**$emailId:** `string` — Source email ID in this company, including campaign, sequence and transactional email rows. Use the underlying email ID, not a campaign ID or transactional slug.
    
</dd>
</dl>

<dl>
<dd>

**$expectedStyleId:** `?string` — revisionId returned by GET. Use null only when no style is stored.
    
</dd>
</dl>

<dl>
<dd>

**$layoutRuleIds:** `?array` — IDs of detected layout habits to keep. Omit to keep every habit detected in the source; pass an empty array to keep none. Unknown IDs are ignored. Review style.layout.rules in the response.
    
</dd>
</dl>

<dl>
<dd>

**$notes:** `?string` — Optional design notes for future generations, for example "always open with a short video". Treated as design guidance, never as email content.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Email Blocks
<details><summary><code>$client-&gt;emailBlocks-&gt;get($type, $request) -> ?GetEmailBlocksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the full field reference for one block type, with a minimal valid example and authoring notes. For line-items, includes optional itemFields mappings from display fields to relative dotted paths within each item. Omitted or blank mappings use standard field names. Mapping values must be strings of at most 200 characters.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailBlocks->get(
    'steps',
    new GetEmailBlocksRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$type:** `string` — Block type, for example list, steps, text, or hero.
    
</dd>
</dl>

<dl>
<dd>

**$conditionFields:** `?string` — Include the per-field condition table in the response. Not needed for `conditional-group`, which always carries it. The table is several times the size of one block type's reference, so a targeted lookup does not carry it unless asked.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailBlocks-&gt;list($request) -> ?ListEmailBlocksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists every block type accepted by the `blocks` array on campaigns, sequence email steps, templates, transactional emails, and email components, with the required and optional fields of each. Derived from the same schemas that validate a write, so it cannot drift from what those endpoints accept.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailBlocks->list(
    new ListEmailBlocksRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$creatableOnly:** `?string` — Hide structural block types the editor manages for you.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailBlocks-&gt;previewCartItems($request) -> ?PreviewCartItemsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires authentication, accepts existing restricted keys, and operates only on supplied data. Does not save or send. Safe to retry.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailBlocks->previewCartItems(
    new PreviewCartItemsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$itemFields:** `?PreviewCartItemsRequestItemFields` — Existing relative dotted paths. Blank values use defaults; unsafe prototype paths are rejected. Suggestions do not replace existing mappings.
    
</dd>
</dl>

<dl>
<dd>

**$items:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$priceUnit:** `?string` — Numeric item prices use cents or explicit major units. The separate total remains in cents.
    
</dd>
</dl>

<dl>
<dd>

**$scenario:** `?string` — Many returns 12 cloned rows; nonempty sample scenarios use a sample product if items are empty. Real preserves supplied items.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Email Components
<details><summary><code>$client-&gt;emailComponents-&gt;create($request) -> ?CreateEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a reusable email component from a block list. Component names are unique per company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->create(
    new CreateEmailComponentsRequest([
        'blocks' => [
            new EmailBlock([
                'type' => EmailBlockType::Text->value,
            ]),
        ],
        'name' => 'Promo banner',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$blocks:** `array` 
    
</dd>
</dl>

<dl>
<dd>

**$componentType:** `?string` — Defaults to section. Creating a footer component does not pin it as the company default.
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;delete($componentId) -> ?DeleteEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes an email component. Emails that already rendered it keep their copied blocks. Deleting the pinned default footer makes new emails fall back to the generated footer.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->delete(
    'componentId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$componentId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;get($componentId) -> ?GetEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a single email component by id.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->get(
    'componentId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$componentId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;getDefault($slot) -> ?GetDefaultEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the component used as the company default for a slot. A 404 means emails fall back to the generated footer.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->getDefault(
    GetDefaultEmailComponentsRequestSlot::Footer->value,
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$slot:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;list($request) -> ?ListEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists reusable email components newest first, including the components pinned as company defaults.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->list(
    new ListEmailComponentsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$defaultsOnly:** `?string` — Return only components pinned as a company default.
    
</dd>
</dl>

<dl>
<dd>

**$slot:** `?string` — Filter by default slot.
    
</dd>
</dl>

<dl>
<dd>

**$type:** `?string` — Filter by component type.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;previewDefault($slot, $request) -> ?PreviewDefaultEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Read-only affected counts and optional layout HTML. Requires the same write scopes and admin role as applying. No subscriber-specific personalization or sending.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->previewDefault(
    PreviewDefaultEmailComponentsRequestSlot::Footer->value,
    new PreviewDefaultEmailComponentsRequest([
        'application' => new FooterApplicationOptions([
            'scopes' => [
                FooterApplicationOptionsScopesItem::Sequences->value,
            ],
        ]),
        'blocks' => [
            new EmailBlock([
                'type' => EmailBlockType::Text->value,
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$slot:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$application:** `FooterApplicationOptions` 
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `array` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$renderPreview:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$sample:** `?PreviewDefaultEmailComponentsRequestSample` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;setDefault($slot, $request) -> ?SetDefaultEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates or replaces the company default component for a slot. New sequence, campaign, and AI-generated emails clone this component when they are built. A default footer always keeps its unsubscribe link enabled; transactional sends hide it at render time. Emails that already exist keep their footer unless application options and a valid previewToken are provided. Preview first to review selected scopes. Personal keys require admin access; keys need emails:write, each selected category write scope, and ab_tests:write for campaigns or sequences.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->setDefault(
    SetDefaultEmailComponentsRequestSlot::Footer->value,
    new SetDefaultEmailComponentsRequest([
        'blocks' => [
            new EmailBlock([
                'type' => EmailBlockType::Text->value,
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$slot:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$application:** `?FooterApplicationOptions` 
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `array` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Defaults to "Default Footer" when creating the footer default.
    
</dd>
</dl>

<dl>
<dd>

**$previewToken:** `?string` — Required for applying a preview to existing content.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailComponents-&gt;update($componentId, $request) -> ?UpdateEmailComponentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates component metadata or replaces its blocks. Replacing blocks bumps the component version; emails built earlier keep the copy they were created with. Editing the component pinned as the default footer keeps its unsubscribe link enabled.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailComponents->update(
    'componentId',
    new UpdateEmailComponentsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$componentId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$componentType:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## EmailDesignSystem
<details><summary><code>$client-&gt;emailDesignSystem-&gt;getEmailDesignSystem() -> ?GetEmailDesignSystemResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the company's effective email design system - the visual identity every AI-generated email (campaigns and sequence steps) renders inside. The identity is stored as the company's emailDesignPrompt direction text; tokens are parsed from that text, with unstated tokens derived deterministically from brand context. isDefault is true while the identity is purely derived.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailDesignSystem->getEmailDesignSystem();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailDesignSystem-&gt;updateEmailDesignSystem($request) -> ?UpdateEmailDesignSystemResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adjusts the company's email design system. This is a partial update - only the passed fields change - and it affects every future AI email generation and sequence enrichment. The adjustment is written into the company's emailDesignPrompt direction text (the single source of truth) - the new identity's sentences are prepended and custom prose the text carried is preserved below them. Pass reset true to clear the direction text and return to the brand-derived defaults.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailDesignSystem->updateEmailDesignSystem(
    new UpdateEmailDesignSystemRequest([
        'compositionSpine' => UpdateEmailDesignSystemRequestCompositionSpine::Editorial->value,
        'designCode' => new UpdateEmailDesignSystemRequestDesignCode([
            'kickerStyle' => UpdateEmailDesignSystemRequestDesignCodeKickerStyle::Letterspaced->value,
            'openerTreatments' => [
                UpdateEmailDesignSystemRequestDesignCodeOpenerTreatmentsItem::EditorialMasthead->value,
                UpdateEmailDesignSystemRequestDesignCodeOpenerTreatmentsItem::TitleLed->value,
            ],
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$compositionSpine:** `?string` — Which worked-example skeleton anchors generation.
    
</dd>
</dl>

<dl>
<dd>

**$designCode:** `?UpdateEmailDesignSystemRequestDesignCode` — Partial visual-grammar adjustment; omitted tokens keep their current value.
    
</dd>
</dl>

<dl>
<dd>

**$reset:** `?bool` — true clears the direction text and returns to brand-derived defaults. Cannot be combined with designCode or compositionSpine.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Emails
<details><summary><code>$client-&gt;emails-&gt;create($request) -> ?CreateEmailsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an email template with block content. Raw HTML is stored as a native HTML body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emails->create(
    new CreateEmailsRequest([
        'name' => 'Welcome email',
        'subject' => 'Welcome',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emails-&gt;update($emailId, $request) -> ?UpdateEmailsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates email metadata or replaces the email body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emails->update(
    'emailId',
    new UpdateEmailsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailId:** `string` — Email ID
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emails-&gt;updateBlocks($emailId, $request) -> ?UpdateBlocksEmailsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replaces an email body or mutates an existing block type.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emails->updateBlocks(
    'emailId',
    new UpdateBlocksEmailsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailId:** `string` — Email ID
    
</dd>
</dl>

<dl>
<dd>

**$blockId:** `?string` — Existing block ID to mutate.
    
</dd>
</dl>

<dl>
<dd>

**$content:** `?string` — Optional replacement content for the mutated block.
    
</dd>
</dl>

<dl>
<dd>

**$type:** `?string` — New block type. Type mutation supports text and html.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## EmailSends
<details><summary><code>$client-&gt;emailSends-&gt;get($emailSendId) -> ?GetEmailSendsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Gets an email delivery snapshot by ID, including queued and test sends, the stored HTML body when available, and retained ClickHouse events when the short-lived row has been cleaned up. Test sends appear in sent-email history and are available through this exact-ID endpoint while their row is retained.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailSends->get(
    'emailSendId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailSendId:** `string` — Email send ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;emailSends-&gt;list($request) -> ?ListEmailSendsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the recent 14-day delivery history with dashboard-equivalent subject, recipient, status, type, bounce, source, pagination, and sorting filters. Pending, successful, and failed test sends are listed with `isTestEmail` set to true. Copied-recipient bookkeeping rows remain hidden except bounced or complained copied recipients.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->emailSends->list(
    new ListEmailSendsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$automationId:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$automationNodeId:** `?string` — Filter to one email step of a sequence. Take the node ID from the `steps` array of the sequence metrics endpoint. Combined with `automationId` the two intersect.
    
</dd>
</dl>

<dl>
<dd>

**$bounceType:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$campaignId:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$days:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$emailType:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$q:** `?string` — Compatibility alias for `search`.
    
</dd>
</dl>

<dl>
<dd>

**$recipient:** `?string` — Case-insensitive recipient email filter.
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` — Case-insensitive subject/title or recipient search. `q` is accepted as an alias.
    
</dd>
</dl>

<dl>
<dd>

**$sortField:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$sortOrder:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Delivery status. Opened includes clicked deliveries.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Case-insensitive subject/title filter. `title` is accepted as an alias.
    
</dd>
</dl>

<dl>
<dd>

**$title:** `?string` — Compatibility alias for `subject`.
    
</dd>
</dl>

<dl>
<dd>

**$transactionalEmailId:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Events
<details><summary><code>$client-&gt;events-&gt;getSample($request) -> ?GetSampleEventsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires subscribers:read and company access. Reads the latest retained exact-name event across workspace subscribers, including older history. Trims surrounding whitespace; does not resolve aliases. No additional recent-only cutoff. Equal timestamps have no guaranteed tie order. Copy sample.properties into a sequence test run customVariables object; the test recipient is unchanged. This read has no side effects and can be retried safely.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->events->getSample(
    new GetSampleEventsRequest([
        'eventName' => 'eventName',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$eventName:** `string` — Exact recorded event name, including custom names. Must not be blank.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;events-&gt;getSchemas($request) -> ?GetSchemasEventsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the published payload of a built-in event - a real example payload per provider, plus every property path with its type, the merge tag that resolves it, and a description wherever the example alone is ambiguous (a null sample, an empty list, a unit that is not obvious, or a type that differs per provider). Omit eventName to list every documented event. Static reference data describing the shape of an event, not what the account has received. An event with no published payload returns documented false; it is still valid to trigger and to build a sequence on, because custom events carry exactly the properties you send.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->events->getSchemas(
    new GetSchemasEventsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$eventName:** `?string` — Event to describe, such as ecommerce.order_placed. Legacy aliases like order.completed resolve to their current name. Omit to list every documented event.
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `?string` — Return only this provider's payload: shopify, woocommerce, manual, api, or stripe.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Feedback
<details><summary><code>$client-&gt;feedback-&gt;submit($request) -> ?SubmitFeedbackResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Submits product feedback about Sequenzy itself to the Sequenzy team - for example, when a workflow you or your user needed is not exposed via the API, CLI, or MCP server.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->feedback->submit(
    new SubmitFeedbackRequest([
        'message' => 'There is no endpoint to bulk-delete campaigns by label.',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$actual:** `?string` — What actually happened instead.
    
</dd>
</dl>

<dl>
<dd>

**$category:** `?string` — Feedback category. Use missing_capability when a needed workflow is not supported. Defaults to other.
    
</dd>
</dl>

<dl>
<dd>

**$context:** `?string` — Optional description of what you were trying to accomplish when you hit the gap.
    
</dd>
</dl>

<dl>
<dd>

**$expected:** `?string` — What you expected to happen.
    
</dd>
</dl>

<dl>
<dd>

**$message:** `string` — The feedback itself. Be specific about what was needed and what was missing or wrong.
    
</dd>
</dl>

<dl>
<dd>

**$resourceIds:** `?array` — IDs of the affected resources so the team can correlate the report with server logs.
    
</dd>
</dl>

<dl>
<dd>

**$source:** `?string` — Where the feedback was submitted from. Defaults to api.
    
</dd>
</dl>

<dl>
<dd>

**$toolCalls:** `?array` — For bug or wrong-outcome reports - the ordered API calls, CLI commands, or MCP tool calls that led to the problem. Summarize arguments; do not include raw subscriber data.
    
</dd>
</dl>

<dl>
<dd>

**$userIntent:** `?string` — For bug or wrong-outcome reports - the user's request, verbatim or closely paraphrased. Omit personal data not needed to reproduce the problem.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## FrequencyCap
<details><summary><code>$client-&gt;frequencyCap-&gt;clearFrequencyCap() -> ?ClearFrequencyCapResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Turns the company frequency cap off. Sequences keep their frequencyCapEnabled setting, but nothing is skipped until a cap is set again. Requires the companies:manage scope plus owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->frequencyCap->clearFrequencyCap();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;frequencyCap-&gt;getFrequencyCap() -> ?GetFrequencyCapResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the company frequency cap, or null when none is set. Only sequences with frequencyCapEnabled respect it; their email steps are skipped for a contact already at the cap. Campaigns count toward the cap but always send. Transactional emails never count. Requires the account:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->frequencyCap->getFrequencyCap();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;frequencyCap-&gt;setFrequencyCap($request) -> ?SetFrequencyCapResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sets or replaces the company frequency cap. It applies from the next email step onward in sequences with frequencyCapEnabled. Requires the companies:manage scope plus owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->frequencyCap->setFrequencyCap(
    new FrequencyCap([
        'maxEmails' => 1,
        'windowHours' => 16,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$request:** `FrequencyCap` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Generation
<details><summary><code>$client-&gt;generation-&gt;generateEmail($request) -> ?GenerateEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Generates a draft email from scratch as structured editor-compatible blocks. By default, the generated content is wrapped with the company's logo and footer.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->generation->generateEmail(
    new GenerateEmailRequest([
        'prompt' => 'Announce our new analytics dashboard to trial users',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$applyBranding:** `?bool` — Whether to wrap generated content with the company logo and footer. Set to false to return raw generated content blocks.
    
</dd>
</dl>

<dl>
<dd>

**$emailType:** `?string` — Email type. Transactional emails include a footer without an unsubscribe link.
    
</dd>
</dl>

<dl>
<dd>

**$prompt:** `string` — What you want the email to say or accomplish.
    
</dd>
</dl>

<dl>
<dd>

**$style:** `?string` — Optional style guidance. Pass "designed" or "plain" to force the designed or plain-text email style; other values (such as "minimal", "branded", or "promotional") are freeform prompt guidance. Defaults to the company's email style preference (designed unless the company chose plain text).
    
</dd>
</dl>

<dl>
<dd>

**$tone:** `?string` — Optional tone guidance.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;generation-&gt;generateSmsMessages($request) -> ?GenerateSmsMessagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Generates draft SMS marketing message variants with per-message encoding and segment counts. Messages exclude opt-out footers and brand prefixes - Sequenzy adds both automatically at send time.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->generation->generateSmsMessages(
    new GenerateSmsMessagesRequest([
        'prompt' => 'Cart reminder with a free-shipping hook',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$count:** `?float` — Number of variants to generate. Defaults to 3.
    
</dd>
</dl>

<dl>
<dd>

**$prompt:** `string` — Description of the SMS to generate.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;generation-&gt;generateSubjectLines($request) -> ?GenerateSubjectLinesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Generates draft subject line variants for a campaign or sequence email.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->generation->generateSubjectLines(
    new GenerateSubjectLinesRequest([
        'topic' => 'April product launch',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$count:** `?float` — Number of variants to generate. Defaults to 5.
    
</dd>
</dl>

<dl>
<dd>

**$topic:** `string` — Topic, campaign idea, or context for the subject lines.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Integrations
<details><summary><code>$client-&gt;integrations-&gt;activatePixel($id) -> ?ActivatePixelIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Installs the Shopify storefront tracking pixel, or repoints an existing one at this account. Idempotent - an already-live pixel returns changed false without writing to the store. Events start arriving on the next storefront visit; nothing is backfilled. Fails with a 400 naming the reconnect step when the store granted an older permission set. Shopify only. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->activatePixel(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Shopify integration ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;connect($request) -> ?ConnectIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, creem, chargebee, clerk, posthog, segment, affonso, or attio. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill; Affonso queues its affiliate backfill; PostHog and Segment can optionally import event history. Attio is outbound-only. Reconnecting replaces stored credentials. OAuth and app-install providers require the dashboard. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->connect(
    new ConnectIntegrationsRequest([
        'provider' => ConnectIntegrationsRequestProvider::Polar->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$apiKey:** `?string` — Provider API key. Required for polar, paddle, dodo, lemon_squeezy, whop, creem, chargebee, affonso, and attio. Attio uses the workspace access token.
    
</dd>
</dl>

<dl>
<dd>

**$historyImport:** `?ConnectIntegrationsRequestHistoryImport` — PostHog and Segment only. Imports event history after connecting: PostHog reads the project archive (projectId + personalApiKey); Segment walks your existing contacts' Unify profiles (spaceId + profileApiToken) and covers at most the last 14 days the Profile API serves, because Segment has no bulk event export.
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `string` — Provider to connect.
    
</dd>
</dl>

<dl>
<dd>

**$providerAccountId:** `?string` — Provider account id: Paddle seller ID, Dodo business ID, Lemon Squeezy numeric store ID, Whop company ID, Creem store ID, or Chargebee site name. Polar resolves it from the API key.
    
</dd>
</dl>

<dl>
<dd>

**$settings:** `?ConnectIntegrationsRequestSettings` — PostHog and Segment: event delivery scope. Attio: listMap (Sequenzy list id to Attio list id or slug) and syncCompanyFromDomain.
    
</dd>
</dl>

<dl>
<dd>

**$webhookSecret:** `?string` — Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and outbound-only attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For Segment, use 16-153 UTF-8 bytes.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;disconnect($id) -> ?DisconnectIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Disconnects Lemon Squeezy locally before removing its managed webhook. Manual webhooks remain under your control. Requires integrations:manage; personal keys require owner or admin access. A cleanupWarning means ingestion is stopped but provider cleanup failed; repeat this request to retry cleanup, including when the integration is already inactive. Other providers require the dashboard. Existing subscribers and history are retained. No request body is required.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->disconnect(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Lemon Squeezy integration ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;get($id) -> ?IntegrationDetail</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Inspects one connected integration - what the provider syncs, every event it emits, the tags each event applies through the company's sync rules, the sequences that trigger on those events, recent activity, the ingestion block naming which lists its contacts join, and prioritized recommendations. Credentials are never returned. Requires the account:read, subscribers:read, sequences:read, and lists:read scopes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->get(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Integration ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;getAttioMapping($id) -> ?IntegrationAttioMapping</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Reads a connected Attio integration's saved Sequenzy-to-Attio list map, this company's Sequenzy lists, and live Attio people-lists using the stored access token. Call this before updating mappings so you have Attio list ids or slugs. Attio only. Requires the account:read and lists:read scopes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->getAttioMapping(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Attio integration ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;getPixel($id) -> ?IntegrationPixelState</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Reads the live state of a Shopify store's storefront tracking pixel. Nothing about the pixel is stored locally, so this queries the store on every call. A confirmed missing or stale pixel prevents on-site events (product views, cart activity, browse abandonment) from arriving; a Shopify read error reports the state as unknown instead. Shopify only. Requires the account:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->getPixel(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Shopify integration ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;list($request) -> ?ListIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists connected integrations with connection state, sync health, last sync error, and any records the last sync could not import normally. Credentials, access tokens, and webhook secrets are never returned.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->list(
    new ListIntegrationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$includeInactive:** `?bool` — Include disconnected integrations. Defaults to false.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;listActivity($request) -> ?ListActivityIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Recent integration webhook and sync activity, newest first. Retained for 24 hours. Payloads are sanitized when written, so no credentials or signatures appear. Requires the account:read and subscribers:read scopes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->listActivity(
    new ListActivityIntegrationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$integrationId:** `?string` — Only show activity for this integration.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Rows to return, 1-100. Defaults to 25.
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `?string` — Only show activity for this provider.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Filter by activity status.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;listCapabilities($request) -> ?ListCapabilitiesIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Describes what each integration provider syncs, which events it emits and when, the subscriber attributes it writes, and which actions it supports. Works whether or not the provider is connected, so it can be used to compare providers before connecting one.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->listCapabilities(
    new ListCapabilitiesIntegrationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$category:** `?string` — Filter by category: payments, ecommerce, auth, analytics, ads, affiliate, cms, crm, or developer.
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `?string` — Return only this provider, for example stripe.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;sync($id) -> ?SyncIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a manual re-sync for a connected integration - customers and revenue for a payment provider (Stripe, Polar, Paddle, Dodo, Lemon Squeezy, Creem, Chargebee, Whop), the user backfill for Supabase, or the event-history import for PostHog and Segment. The Supabase sync reads the project, schema, and table already configured for the integration and returns 400 when none is configured. PostHog and Segment re-run their event-history imports with credentials stored at connect time and are the supported retry path for failed imports; each restarts from the beginning, already-imported events dedupe, and returns 409 while queued or syncing. Segment requires a saved Unify space ID and Profile API token and covers the most recent 14 days served by the Profile API. Terminal BullMQ failures release imports for retry. Returns immediately; poll the integration to watch syncStatus. Other providers re-sync from the dashboard. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->sync(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Integration ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;updateAttioSettings($id, $request) -> ?IntegrationAttioMapping</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Saves Sequenzy-to-Attio list mappings and/or company-matching on an already-connected Attio integration using the stored access token. Does not require the secret again. listMap is a full replacement when provided; an empty object clears every mapping. Provide at least one of listMap or syncCompanyFromDomain. Idempotent. Attio only. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->updateAttioSettings(
    'id',
    new UpdateAttioSettingsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Attio integration ID.
    
</dd>
</dl>

<dl>
<dd>

**$listMap:** `?array` — Complete Sequenzy list id to Attio list UUID or api slug map. Replaces the saved map. Pass {} to clear every mapping.
    
</dd>
</dl>

<dl>
<dd>

**$syncCompanyFromDomain:** `?bool` — When true, upsert a company from the person's non-free-mail email domain.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;integrations-&gt;updateSync($id, $request) -> ?UpdateSyncIntegrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Controls what a connected integration does to the contact list. Two independent settings - `syncEnabled` turns bulk imports and backfills on or off, and `listIds` chooses which lists the contacts the provider's live webhook creates join. Neither stops that webhook: disabling bulk sync only pauses full imports, and list targeting changes membership only. Contacts are still created, their attributes still sync, sync-rule tags still apply, and default any_contact sequences still enroll them. Explicit any_list and specific-list sequences require a matching membership and do not enroll a list-less contact. `listIds` takes effect on future provider writes: nothing is applied retroactively and nobody is ever removed from a list. Wix or Webflow submissions, Shopify customer updates, and Supabase resubscriptions can add an existing contact to the new targets; Stripe applies targeting only when its webhook creates a subscriber. Provider support is declared in the catalog's `actions` as set_list_targeting. At least one field is required, an in-flight sync must finish before bulk sync can be disabled, and setting the current state succeeds with `changed: false`. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->integrations->updateSync(
    'id',
    new UpdateSyncIntegrationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Integration ID.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Lists that contacts created by this integration join, applied from the provider's next write onward. `null` clears the choice so they follow the workspace default lists; `[]` means they join no list; a populated array means exactly those lists. Every ID must belong to this company.
    
</dd>
</dl>

<dl>
<dd>

**$syncEnabled:** `?bool` — True to enable bulk imports and backfills, false to pause them. This does not stop the provider's live webhook creating contacts.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## LandingPages
<details><summary><code>$client-&gt;landingPages-&gt;connectDedicatedDomain($landingPageId, $request) -> ?ConnectDedicatedDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Assigns one hostname to one landing page. The page opens at the hostname root, while existing workspace and Sequenzy URLs remain available.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->connectDedicatedDomain(
    'landingPageId',
    new ConnectDedicatedDomainLandingPagesRequest([
        'domain' => 'offer.example.com',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$domain:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;connectDomain($request) -> ?ConnectDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Connects or replaces the custom domain for published landing pages.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->connectDomain(
    new ConnectDomainLandingPagesRequest([
        'domain' => 'pages.example.com',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `string` — Custom landing page domain.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;create($request) -> ?CreateLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a draft landing page from default template content or supplied builder JSON.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->create(
    new CreateLandingPagesRequest([
        'name' => 'Product Waitlist',
        'slug' => 'product-waitlist',
        'template' => CreateLandingPagesRequestTemplate::Waitlist->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$content:** `?LandingPageContent` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Landing page name.
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` — URL slug. It is normalized and made unique for the company.
    
</dd>
</dl>

<dl>
<dd>

**$template:** `?string` — Template key used when content is omitted.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;delete($landingPageId) -> ?DeleteLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a landing page.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->delete(
    'landingPageId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;duplicate($landingPageId, $request) -> ?DuplicateLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Copies a landing page into a new draft with its own slug, views, and conversions. The original keeps its published URL and stats.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->duplicate(
    'landingPageId',
    new DuplicateLandingPagesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID to copy
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Name for the copy. Defaults to the original name with a "(copy)" suffix.
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` — Slug for the copy. Normalized and made unique within the company.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;get($landingPageId) -> ?GetLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one landing page with builder content and public URLs.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->get(
    'landingPageId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;getDedicatedDomain($landingPageId) -> ?GetDedicatedDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the domain assigned only to this landing page plus its workspace fallback.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->getDedicatedDomain(
    'landingPageId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;getDomain() -> ?GetDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the custom landing page domain settings for the authenticated company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->getDomain();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;getStats($landingPageId, $request) -> ?GetStatsLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns visits, unique visits, clicks, subscribes, conversion rate, a daily histogram, referrers, UTM sources, and crawler hits. Default totals exclude known crawlers. Preview URLs and the editor never count. The all period covers retained analytics only; dataAvailableFrom marks the beginning of available event coverage.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->getStats(
    'landingPageId',
    new GetStatsLandingPagesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?string` — Custom range end as an ISO 8601 timestamp
    
</dd>
</dl>

<dl>
<dd>

**$includeBots:** `?bool` — Include known crawlers in visit totals
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Time window. One of 7d, 30d, 90d, or all.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?string` — Custom range start as an ISO 8601 timestamp
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;list() -> ?ListLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists landing pages for the authenticated company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;publish($landingPageId, $request) -> ?PublishLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Publishes a landing page and optionally updates name, slug, or content first.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->publish(
    'landingPageId',
    new PublishLandingPagesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>

<dl>
<dd>

**$content:** `?LandingPageContent` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;removeDedicatedDomain($landingPageId) -> ?RemoveDedicatedDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes only the page-specific hostname. Workspace and Sequenzy fallback URLs remain available.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->removeDedicatedDomain(
    'landingPageId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;render($landingPageId) -> ?RenderLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a signed, unlisted preview URL for the current landing page content. Works for drafts. Does not publish the page or collect signup form submissions on a draft preview.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->render(
    'landingPageId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;unpublish($landingPageId, $request) -> ?UnpublishLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a landing page to draft status and optionally updates name, slug, or content first.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->unpublish(
    'landingPageId',
    new UnpublishLandingPagesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>

<dl>
<dd>

**$content:** `?LandingPageContent` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;update($landingPageId, $request) -> ?UpdateLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a draft or published page. Published-page changes take effect immediately, including slug changes. Omitted top-level fields stay unchanged; content replaces the entire builder document. Read the existing content before editing it. No additional publish call is required for an already-published page.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->update(
    'landingPageId',
    new UpdateLandingPagesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` — Landing page ID
    
</dd>
</dl>

<dl>
<dd>

**$content:** `?LandingPageContent` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;updateDomainSettings($request) -> ?UpdateDomainSettingsLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replaces the custom landing page domain, verifies the current domain, or both.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->updateDomainSettings(
    new UpdateDomainSettingsLandingPagesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `?string` — Replacement custom landing page domain.
    
</dd>
</dl>

<dl>
<dd>

**$verify:** `?bool` — Check DNS and SSL status for the current domain.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;verifyDedicatedDomain($landingPageId) -> ?VerifyDedicatedDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Checks DNS and SSL status for the hostname assigned to this landing page.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->verifyDedicatedDomain(
    'landingPageId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$landingPageId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;landingPages-&gt;verifyDomain() -> ?VerifyDomainLandingPagesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Checks DNS and SSL status for the current custom landing page domain.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->landingPages->verifyDomain();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Lists
<details><summary><code>$client-&gt;lists-&gt;addSubscribers($listId, $request) -> ?AddSubscribersListsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds existing or new subscribers to one subscriber list from an email array. Use this endpoint without a `/bulk` suffix. Requires the lists:write and subscribers:write scopes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->lists->addSubscribers(
    'listId',
    new AddSubscribersListsRequest([
        'emails' => [
            'emails',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$listId:** `string` — Subscriber list ID.
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$emails:** `array` — Up to 500 email addresses per request.
    
</dd>
</dl>

<dl>
<dd>

**$enrollInSequences:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$optInMode:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;lists-&gt;create($request) -> ?CreateListsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a subscriber list for grouping contacts.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->lists->create(
    new CreateListsRequest([
        'name' => 'name',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$allowMemberUnsubscribe:** `?bool` — Allow current private-list members to see its name and opt out in preferences. Defaults false on create; omission preserves on update and false disables. Null is rejected. Stored but has no effect on public lists. Does not permit private joining or rejoining.
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` — Optional internal workspace metadata. Never shown in hosted or embedded subscriber preferences.
    
</dd>
</dl>

<dl>
<dd>

**$isPrivate:** `?bool` — Set to true to hide the list from subscriber preferences unless allowMemberUnsubscribe is enabled for current members. Public lists expose only their name on that page; descriptions remain internal. List privacy does not override a subscriber's global unsubscribe. Defaults to false when omitted.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;lists-&gt;delete($listId) -> ?DeleteListsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a subscriber list and removes all list memberships. Subscribers themselves are not deleted.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->lists->delete(
    'listId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$listId:** `string` — Subscriber list ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;lists-&gt;list() -> ?ListListsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists subscriber lists for the authenticated company. Each list includes subscriberCount (current members of any status) and activeSubscriberCount (current members with status=active). Members who unsubscribed from the list are not counted.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->lists->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;lists-&gt;removeSubscribers($listId, $request) -> ?RemoveSubscribersListsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes subscribers from one subscriber list by email or subscriber ID. Subscribers themselves are not deleted. Requires the lists:write and subscribers:write scopes, the same as adding them.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->lists->removeSubscribers(
    'listId',
    new RemoveSubscribersListsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$listId:** `string` — Subscriber list ID.
    
</dd>
</dl>

<dl>
<dd>

**$emails:** `?array` — Email addresses to remove. Combined with subscriberIds, up to 500 per request.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberIds:** `?array` — Subscriber IDs to remove. Combined with emails, up to 500 per request.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;lists-&gt;update($listId, $request) -> ?UpdateListsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a subscriber list's name, description, or privacy flag. Only provided fields are changed.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->lists->update(
    'listId',
    new UpdateListsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$listId:** `string` — Subscriber list ID.
    
</dd>
</dl>

<dl>
<dd>

**$allowMemberUnsubscribe:** `?bool` — Allow current private-list members to see its name and opt out in preferences. Defaults false on create; omission preserves on update and false disables. Null is rejected. Stored but has no effect on public lists. Does not permit private joining or rejoining.
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` — New internal list description. Never shown in hosted or embedded subscriber preferences. Pass null to clear it.
    
</dd>
</dl>

<dl>
<dd>

**$isPrivate:** `?bool` — Set to true to hide the list from subscriber preferences unless allowMemberUnsubscribe is enabled for current members. Set to false to expose only its name on that page; descriptions remain internal. List privacy does not override a subscriber's global unsubscribe. Omit this field to leave the current visibility unchanged.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — New list name.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Media
<details><summary><code>$client-&gt;media-&gt;completeEmailImageUpload($request) -> ?CompleteEmailImageUploadResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Idempotently registers a completed company-scoped image upload in the shared media library and returns its hosted URL.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->media->completeEmailImageUpload(
    new CompleteEmailImageUploadRequest([
        'altText' => 'altText',
        'contentType' => 'image/png',
        'filename' => 'filename',
        'fileSizeBytes' => 1,
        'key' => 'key',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$altText:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$contentType:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$filename:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$fileSizeBytes:** `int` 
    
</dd>
</dl>

<dl>
<dd>

**$height:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$key:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$width:** `?int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;media-&gt;createEmailImageUploadUrl($request) -> ?CreateEmailImageUploadUrlResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns an authenticated API URL for a block-ready email image. PUT the exact bytes to uploadUrl using the same API credentials, then register the key with POST /media/complete-upload. The public object does not exist until its bytes pass server-side validation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->media->createEmailImageUploadUrl(
    new CreateEmailImageUploadUrlRequest([
        'contentType' => 'image/png',
        'filename' => 'filename',
        'fileSizeBytes' => 1,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$contentType:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$filename:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$fileSizeBytes:** `int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;media-&gt;uploadEmailImageBytes($request) -> ?UploadEmailImageBytesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Uploads the exact bytes to the authenticated URL returned by POST /media/upload-url. The server enforces the requested size, verifies the file signature, and creates the public object only once.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->media->uploadEmailImageBytes($request): ?UploadEmailImageBytesResponse;
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$contentType:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$filename:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$fileSizeBytes:** `int` 
    
</dd>
</dl>

<dl>
<dd>

**$key:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Migrations
<details><summary><code>$client-&gt;migrations-&gt;approvePlan($runId, $request) -> ?ApprovePlanMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Approves provider-neutral resources and freezes the execution plan for a migration run.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->approvePlan(
    'runId',
    new ApprovePlanMigrationsRequest([
        'resourceIds' => [
            'resourceIds',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$resourceIds:** `array` 
    
</dd>
</dl>

<dl>
<dd>

**$resourceOptions:** `?array` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;migrations-&gt;cancel($runId) -> ?CancelMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Cancels queued/pre-execution runs immediately. Running imports move to cancel_requested while workers stop linked subscriber import chunks, then finish as canceled.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->cancel(
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;migrations-&gt;connectSource($runId, $request) -> ?ConnectSourceMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Stores a provider credential on an existing migration run connection.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->connectSource(
    'runId',
    new ConnectSourceMigrationsRequest([
        'credential' => 'credential',
        'provider' => 'provider',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$credential:** `string` — Provider API credential.
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `string` — Provider adapter ID. Supported values include `active-campaign`, `brevo`, `constant-contact`, `customer-io`, `drip`, `hubspot`, `kit`, `klaviyo`, `loops`, `mailchimp`, `mailerlite`, `mailjet`, `omnisend`, `resend`, and `sendgrid`.
    
</dd>
</dl>

<dl>
<dd>

**$providerLabel:** `?string` — Optional display label for manual providers.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;migrations-&gt;discoverSource($runId) -> ?DiscoverSourceMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues provider discovery for a migration run.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->discoverSource(
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;migrations-&gt;getAgentPackage($runId) -> ?GetAgentPackageMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns endpoint URLs and exact call sequence for an agent-assisted migration.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->getAgentPackage(
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;migrations-&gt;getRun($runId) -> ?GetRunMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns provider-neutral migration status, discovery, plan, progress, and report.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->getRun(
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;migrations-&gt;start($runId, $request) -> ?StartMigrationsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues execution for an approved migration run. Queued or running runs return their current state without another execution or plan change. Completed, failed, canceled and cancel_requested runs return 400. At least one selected resource is required, from resourceIds or the previously approved plan. resourceOptions applies only with a nonempty resourceIds selection.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->migrations->start(
    'runId',
    new StartMigrationsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$resourceIds:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$resourceOptions:** `?array` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## NotificationPreferences
<details><summary><code>$client-&gt;notificationPreferences-&gt;get($request) -> ?NotificationPreferences</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the account notification settings for the API key's own user in the active company, along with the modes each event supports and the platform defaults. Every event available to the requesting client is present; an event the user has never configured reports its default. Default Node and Undici clients must send x-sequenzy-client to receive weekly_report. There is no way to read another member's preferences through this API. Requires account:read.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->notificationPreferences->get(
    new GetNotificationPreferencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenzyClient:** `?string` — Identifies a client that supports the complete notification event list, including weekly_report. Any non-empty value opts a default Node or Undici client into the full response.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;notificationPreferences-&gt;update($request) -> ?NotificationPreferences</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Changes which account notifications Sequenzy emails the API key's own user for the active company. Events not listed keep their current value. Useful before a bulk import or migration, though imports never trigger new-subscriber notifications in the first place. Requires companies:manage; account:read alone cannot mutate these settings.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->notificationPreferences->update(
    new UpdateNotificationPreferencesRequest([
        'notificationPreferences' => [
            new NotificationPreference([
                'event' => NotificationPreferenceEvent::NewSubscriber->value,
                'mode' => NotificationPreferenceMode::Off->value,
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenzyClient:** `?string` — Identifies a client that supports the complete notification event list, including weekly_report. Any non-empty value opts a default Node or Undici client into the full response.
    
</dd>
</dl>

<dl>
<dd>

**$notificationPreferences:** `array` — Preferences to set. Events not listed are left unchanged.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Orders
<details><summary><code>$client-&gt;orders-&gt;push($request) -> ?PushOrdersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Pushes a normalized order from any e-commerce platform. Triggers the matching ecommerce.* event (order placed, cancelled, fulfilled, or refunded), updates the customer's revenue attributes (ltv, totalSpent, ordersCount, aov), cancels superseded commerce automations, and schedules replenishment reminders. Processing is asynchronous.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->orders->push(
    new PushOrdersRequest([
        'currency' => 'USD',
        'customer' => new CommerceCustomer([
            'email' => 'buyer@example.com',
        ]),
        'orderId' => 'order-1001',
        'totalCents' => 8850,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$currency:** `string` — ISO 4217 currency code
    
</dd>
</dl>

<dl>
<dd>

**$customer:** `CommerceCustomer` 
    
</dd>
</dl>

<dl>
<dd>

**$customerTotals:** `?PushOrdersRequestCustomerTotals` — Authoritative customer aggregates from your platform. When provided, these override Sequenzy's additive revenue bookkeeping.
    
</dd>
</dl>

<dl>
<dd>

**$items:** `?array` — Order line items
    
</dd>
</dl>

<dl>
<dd>

**$orderedAt:** `?DateTime` — ISO 8601 timestamp of when the order happened. Defaults to now.
    
</dd>
</dl>

<dl>
<dd>

**$orderId:** `string` — Unique order identifier in your platform. Used for idempotency - pushing the same orderId twice never double counts revenue.
    
</dd>
</dl>

<dl>
<dd>

**$orderNumber:** `?string` — Human-facing order number, if different from orderId
    
</dd>
</dl>

<dl>
<dd>

**$properties:** `?array` — Extra event properties to attach to the triggered ecommerce.* event
    
</dd>
</dl>

<dl>
<dd>

**$refundAmountCents:** `?int` — For refunded orders - refunded amount in cents
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Lifecycle status of this order event
    
</dd>
</dl>

<dl>
<dd>

**$totalCents:** `int` — Order total in cents
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;orders-&gt;trackCheckoutStarted($request) -> ?TrackCheckoutStartedResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Tracks a started checkout and triggers the ecommerce.checkout_started event, which can power abandoned checkout automations.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->orders->trackCheckoutStarted(
    new TrackCheckoutStartedRequest([
        'checkoutId' => 'checkout-abc123',
        'customer' => new CommerceCustomer([
            'email' => 'buyer@example.com',
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$checkoutId:** `string` — Unique checkout identifier in your platform
    
</dd>
</dl>

<dl>
<dd>

**$checkoutUrl:** `?string` — URL the customer can use to resume the checkout
    
</dd>
</dl>

<dl>
<dd>

**$currency:** `?string` — ISO 4217 currency code
    
</dd>
</dl>

<dl>
<dd>

**$customer:** `CommerceCustomer` 
    
</dd>
</dl>

<dl>
<dd>

**$items:** `?array` — Checkout line items
    
</dd>
</dl>

<dl>
<dd>

**$properties:** `?array` — Extra event properties to attach to the triggered event
    
</dd>
</dl>

<dl>
<dd>

**$totalCents:** `?int` — Checkout total in cents
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Products
<details><summary><code>$client-&gt;products-&gt;attachDelivery($productId, $request) -> ?AttachDeliveryProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Attaches the distributable file delivered after a purchase of this product. Purchase events then expose it as download.url / download.name. Accepts the internal product id or, for Commerce API products, your productId.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->attachDelivery(
    'productId',
    new AttachDeliveryProductsRequest([
        'url' => 'url',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$productId:** `string` — Internal product id, or your own productId for products pushed via the Commerce API.
    
</dd>
</dl>

<dl>
<dd>

**$fileName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$fileSizeBytes:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$mimeType:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$source:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$url:** `string` — Public http(s) URL of the file.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;createDeliveryUploadUrl($request) -> ?CreateDeliveryUploadUrlProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a presigned URL to upload a distributable file. PUT the file bytes to uploadUrl, then attach publicUrl to a product.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->createDeliveryUploadUrl(
    new CreateDeliveryUploadUrlProductsRequest([
        'contentType' => 'application/pdf',
        'filename' => 'filename',
        'fileSizeBytes' => 1,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$contentType:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$filename:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$fileSizeBytes:** `int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;delete($productId) -> ?DeleteProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a product previously pushed via the Commerce API, identified by your productId. Products synced from other providers are not affected.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->delete(
    'productId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$productId:** `string` — Your product identifier
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;get($productId) -> ?GetProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a product previously pushed via the Commerce API, identified by your productId.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->get(
    'productId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$productId:** `string` — Your product identifier
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;list($request) -> ?ListProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists products in the catalog. Includes products synced from Stripe, Shopify/WooCommerce, and products pushed via the Commerce API.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->list(
    new ListProductsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` — Maximum number of products to return
    
</dd>
</dl>

<dl>
<dd>

**$offset:** `?int` — Number of products to skip
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `?string` — Filter products by source provider
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` — Filter products by title
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;registerBackInStock($request) -> ?RegisterBackInStockResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Registers a customer's request to be notified when a product (pushed via the Commerce API) is back in stock. When a later product upsert marks the product or variant in stock again, the ecommerce.back_in_stock event fires for waiting subscribers.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->registerBackInStock(
    new RegisterBackInStockRequest([
        'customer' => new CommerceCustomer([
            'email' => 'buyer@example.com',
        ]),
        'productId' => 'SKU-PROTEIN-1KG',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$customer:** `CommerceCustomer` 
    
</dd>
</dl>

<dl>
<dd>

**$productId:** `string` — Your product identifier
    
</dd>
</dl>

<dl>
<dd>

**$productTitle:** `?string` — Product title snapshot. Defaults to the synced product title.
    
</dd>
</dl>

<dl>
<dd>

**$variantId:** `?string` — Your variant identifier. Defaults to productId for products without variants.
    
</dd>
</dl>

<dl>
<dd>

**$variantTitle:** `?string` — Variant title snapshot. Defaults to the synced variant title.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;removeDelivery($productId) -> ?RemoveDeliveryProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes the attached distributable file from a product. Accepts the internal product id or, for Commerce API products, your productId.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->removeDelivery(
    'productId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$productId:** `string` — Internal product id, or your own productId for products pushed via the Commerce API.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;syncStripe($request) -> ?SyncStripeProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a sync of the Stripe product catalog into the products list. Requires an active Stripe integration with bulk sync enabled.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->syncStripe(
    new SyncStripeProductsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$integrationId:** `?string` — Stripe integration to sync. When omitted, the most recently connected active integration with bulk sync enabled is used.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;products-&gt;upsert($request) -> ?UpsertProductsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates or updates up to 100 products, keyed by your productId. Products pushed here behave like Shopify/WooCommerce products - they power product blocks, replenishment reminders, and back-in-stock notifications. Stock transitions trigger back-in-stock events for waiting subscribers. Updates are partial - omitted optional fields keep their stored values; pass an explicit null to clear one.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->products->upsert(
    new UpsertProductsRequest([
        'products' => [
            new UpsertProductsRequestProductsItem([
                'productId' => 'SKU-PROTEIN-1KG',
                'title' => 'Protein Powder',
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$products:** `array` — Products to create or update
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Push
<details><summary><code>$client-&gt;push-&gt;cancelPushCampaign($campaignId) -> ?CancelPushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Stops a scheduled or sending push campaign. Contacts who have not been sent the push yet are skipped; delivered notifications cannot be recalled. Requires the campaigns:send scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->cancelPushCampaign(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;clearApnsCredentials() -> ?ClearApnsCredentialsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes the APNs key. iOS devices stop receiving push until a key is saved again; registered devices are kept. Requires the integrations:manage scope and edit access to the workspace.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->clearApnsCredentials();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;clearFcmCredentials() -> ?ClearFcmCredentialsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes the Firebase service account. Android devices stop receiving push until a key is uploaded again; registered devices are kept. Requires the integrations:manage scope and edit access to the workspace.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->clearFcmCredentials();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;createPushCampaign($request) -> ?CreatePushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a push campaign draft. Content and audience can be set now or later. Requires the campaigns:write scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->createPushCampaign(
    new CreatePushCampaignRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$body:** `?string` — Notification message. Merge tags are supported.
    
</dd>
</dl>

<dl>
<dd>

**$iconUrl:** `?string` — Optional https icon for web push. Defaults to the workspace icon.
    
</dd>
</dl>

<dl>
<dd>

**$imageUrl:** `?string` — Optional https image shown in the notification.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$platforms:** `?array` — Limit delivery to these platforms. Omit or pass an empty array for every platform.
    
</dd>
</dl>

<dl>
<dd>

**$targetLists:** `?array` — Audience, same shape as campaign targetLists, for example {"type":"all"}, {"type":"lists","listIds":["..."]}, {"type":"segment","segmentId":"..."} or {"type":"rules","include":[...]}. Only contacts with an active push device receive the campaign.
    
</dd>
</dl>

<dl>
<dd>

**$title:** `?string` — Notification title. Merge tags such as {{FIRST_NAME|there}} are supported.
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Link opened on tap. An https URL, an app deep link (myapp://...), or a merge tag. Browsers only open https links. null clears it.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;deletePushDevice($deviceId) -> ?DeletePushDeviceResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Marks a device unsubscribed so it stops receiving push. The device can register again from your site or app. Requires the subscribers:write scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->deletePushDevice(
    'deviceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$deviceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;duplicatePushCampaign($campaignId, $request) -> ?DuplicatePushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Copies a push campaign's content and audience into a new draft. Requires the campaigns:write scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->duplicatePushCampaign(
    'campaignId',
    new DuplicatePushCampaignRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Name for the copy. Defaults to the original name with (Copy).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;estimatePushCampaignRecipients($request) -> ?EstimatePushCampaignRecipientsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Counts the contacts in an audience (audienceCount) and those with an active device on the selected platforms (eligibleCount). Email status does not affect push eligibility. Requires the campaigns:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->estimatePushCampaignRecipients(
    new EstimatePushCampaignRecipientsRequest([
        'targetLists' => [
            'key' => "value",
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$platforms:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$targetLists:** `array` — Audience, same shape as campaign targetLists.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;getPushCampaign($campaignId) -> ?GetPushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a push campaign's content, audience and status, plus delivery stats once it has started sending (null for drafts). Requires the campaigns:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->getPushCampaign(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;getPushCampaignStats($campaignId) -> ?GetPushCampaignStatsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns delivery and engagement stats for a push campaign. Test sends are excluded. Requires the campaigns:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->getPushCampaignStats(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;getPushSettings() -> ?GetPushSettingsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns web push, APNs (iOS) and Firebase (Android) readiness, the last credential error for each platform, the default icon and active device counts. Secrets are never returned. Requires the account:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->getPushSettings();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;listPushCampaigns($request) -> ?ListPushCampaignsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists push campaigns, newest first. Push campaigns also appear in GET /campaigns with type push. Requires the campaigns:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->listPushCampaigns(
    new ListPushCampaignsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$offset:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;listPushDevices($request) -> ?ListPushDevicesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists registered browsers and app installs in a stable order; page with the returned cursor. Tokens are never returned in full. Requires the subscribers:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->listPushDevices(
    new ListPushDevicesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$cursor:** `?string` — nextCursor from the previous page.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Only this contact's devices.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$platform:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Only this subscriber's devices.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;registerPushDevice($request) -> ?RegisterPushDeviceResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Registers or refreshes a device, typically from your app backend after the app receives its APNs or FCM token. Re-registering a known token reactivates it, refreshes its metadata and moves it to the given contact. An unknown email becomes a contact quietly (no lists, no contact_added sequences). Each contact keeps at most 20 active devices; the least recently seen are retired. Returns 201 for a new token and 200 for an existing one. Requires the subscribers:write scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->registerPushDevice(
    new RegisterPushDeviceRequest([
        'platform' => RegisterPushDeviceRequestPlatform::Ios->value,
        'token' => 'token',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$appVersion:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$deviceName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Contact to link. Created quietly when new.
    
</dd>
</dl>

<dl>
<dd>

**$keys:** `?RegisterPushDeviceRequestKeys` — Web only. PushSubscription.toJSON().keys.
    
</dd>
</dl>

<dl>
<dd>

**$locale:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$osVersion:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$platform:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Existing subscriber to link instead of email.
    
</dd>
</dl>

<dl>
<dd>

**$timezone:** `?string` — IANA timezone.
    
</dd>
</dl>

<dl>
<dd>

**$token:** `string` — iOS: the hex APNs device token. Android: the FCM registration token. Web: the PushSubscription endpoint (also send keys).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;sendPushCampaign($campaignId, $request) -> ?SendPushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sends a draft or scheduled push campaign now, or schedules it when scheduledAt is a future ISO 8601 time. Requires content, an audience with at least one contact that has an active device, and at least one selected platform set up in push settings. The audience is re-evaluated when delivery starts. Requires the campaigns:send scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->sendPushCampaign(
    'campaignId',
    new SendPushCampaignRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>

<dl>
<dd>

**$scheduledAt:** `?DateTime` — Future ISO 8601 time. Omit or null to send immediately.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;sendTestPush($request) -> ?SendTestPushResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sends a real push to one device (deviceId) or to every active device of a contact (email or subscriberId). Provide title and/or body. Tests are excluded from stats and limited to 200 per company in a rolling 24-hour window. Requires the campaigns:send scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->sendTestPush(
    new SendTestPushRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$body:** `?string` — Notification message. Merge tags are supported.
    
</dd>
</dl>

<dl>
<dd>

**$deviceId:** `?string` — One device to notify.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Notify every active device of this contact.
    
</dd>
</dl>

<dl>
<dd>

**$iconUrl:** `?string` — Optional https icon for web push. Defaults to the workspace icon.
    
</dd>
</dl>

<dl>
<dd>

**$imageUrl:** `?string` — Optional https image shown in the notification.
    
</dd>
</dl>

<dl>
<dd>

**$platforms:** `?array` — Limit delivery to these platforms. Omit or pass an empty array for every platform.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Notify every active device of this subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$title:** `?string` — Notification title. Merge tags such as {{FIRST_NAME|there}} are supported.
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Link opened on tap. An https URL, an app deep link (myapp://...), or a merge tag. Browsers only open https links. null clears it.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;setApnsCredentials($request) -> ?SetApnsCredentialsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Connects iOS push with an APNs auth key (.p8). The key is validated, encrypted at rest and never returned. Replacing the key clears the last credential error. Requires the integrations:manage scope and edit access to the workspace.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->setApnsCredentials(
    new SetApnsCredentialsRequest([
        'bundleId' => 'com.example.app',
        'keyId' => 'ABC123DEFG',
        'privateKey' => 'privateKey',
        'teamId' => 'DEF123GHIJ',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$bundleId:** `string` — Your app's bundle ID.
    
</dd>
</dl>

<dl>
<dd>

**$environment:** `?string` — production for App Store and TestFlight builds, sandbox for Xcode development builds.
    
</dd>
</dl>

<dl>
<dd>

**$keyId:** `string` — 10-character APNs key ID.
    
</dd>
</dl>

<dl>
<dd>

**$privateKey:** `string` — Full contents of the AuthKey_XXXXXXXXXX.p8 file.
    
</dd>
</dl>

<dl>
<dd>

**$teamId:** `string` — 10-character Apple developer team ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;setFcmCredentials($request) -> ?SetFcmCredentialsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Connects Android push with a Firebase service account key. The file is validated (it must be a service account with a private key; token_uri, when present, must be Google's), encrypted at rest and never returned. Requires the integrations:manage scope and edit access to the workspace.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->setFcmCredentials(
    new SetFcmCredentialsRequest([
        'serviceAccount' => 'serviceAccount',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$serviceAccount:** `string|array` — The service account JSON file from Firebase project settings > Service accounts, as a JSON object or a string. The account needs the Firebase Cloud Messaging API Admin role.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;unschedulePushCampaign($campaignId) -> ?UnschedulePushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Moves a scheduled push campaign back to draft. The queued send is discarded. Requires the campaigns:send scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->unschedulePushCampaign(
    'campaignId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;updatePushCampaign($campaignId, $request) -> ?UpdatePushCampaignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a draft or scheduled push campaign. Only the fields you pass change; content fields merge over the stored content. A scheduled campaign keeps its schedule and cannot be cleared to empty content. Requires the campaigns:write scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->updatePushCampaign(
    'campaignId',
    new UpdatePushCampaignRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$campaignId:** `string` — Push campaign ID.
    
</dd>
</dl>

<dl>
<dd>

**$body:** `?string` — Notification message. Merge tags are supported.
    
</dd>
</dl>

<dl>
<dd>

**$iconUrl:** `?string` — Optional https icon for web push. Defaults to the workspace icon.
    
</dd>
</dl>

<dl>
<dd>

**$imageUrl:** `?string` — Optional https image shown in the notification.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$platforms:** `?array` — Limit delivery to these platforms. Omit or pass an empty array for every platform.
    
</dd>
</dl>

<dl>
<dd>

**$targetLists:** `?array` — Audience, same shape as campaign targetLists.
    
</dd>
</dl>

<dl>
<dd>

**$title:** `?string` — Notification title. Merge tags such as {{FIRST_NAME|there}} are supported.
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Link opened on tap. An https URL, an app deep link (myapp://...), or a merge tag. Browsers only open https links. null clears it.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;push-&gt;updateWebPushSettings($request) -> ?UpdateWebPushSettingsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Enables or disables web push, or sets the default notification icon. The first enable generates the workspace's VAPID key pair; disabling keeps the keys so existing browser subscriptions remain valid when you enable again. Requires the integrations:manage scope and edit access to the workspace.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->push->updateWebPushSettings(
    new UpdateWebPushSettingsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$defaultIconUrl:** `?string` — Default https icon used when a message has no icon. null or an empty string clears it.
    
</dd>
</dl>

<dl>
<dd>

**$enabled:** `?bool` — Turn web push on or off. Provide enabled and/or defaultIconUrl.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## References
<details><summary><code>$client-&gt;references-&gt;createGalleryBrandRequest($request) -> ?GalleryBrandRequestResult</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Asks for a brand, usually a competitor, to be added to the Sequenzy email gallery, the same as **Suggest a brand** in the dashboard's gallery picker. Asking again for the same domain keeps the one request (a new `note` replaces the old) and returns 200 with `created` false, so retries never duplicate. If the brand is already in the gallery, the request comes back with status `available`. Requires `templates:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->createGalleryBrandRequest(
    new CreateGalleryBrandRequestRequest([
        'website' => 'website',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$note:** `?string` — Optional. What you want to see from the brand, such as its onboarding emails.
    
</dd>
</dl>

<dl>
<dd>

**$website:** `string` — The brand's website or domain, such as `competitor.com` or `https://competitor.com/pricing`. It is reduced to the registrable domain, so `www.competitor.com` and `competitor.com` are the same request. It cannot be your own website.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;deleteGalleryBrandRequest($id) -> ?DeleteGalleryBrandRequestResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Withdraws one of your brand requests. A brand already added to the gallery stays there. Requires `templates:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->deleteGalleryBrandRequest(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;listEmailReferences($request) -> ?ListEmailReferencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists real emails (and, for sequences, whole sequences) from the Sequenzy email gallery to model a new email on, for the kind of email you are creating. By default they come from the gallery brands most like you, ranked by how close their businesses (what each sells, and to whom) are in meaning to your company description, closest first (rankings are reused for up to 10 minutes; a description change counts at once). Each `url` works with the from-example endpoints. Always empty when the gallery is not available. Requires `templates:read`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->listEmailReferences(
    new ListEmailReferencesRequest([
        'kind' => ListEmailReferencesRequestKind::Campaign->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$kind:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — For `scope=similar` without `q`, most emails (and sequences) to return. Also caps sequences elsewhere.
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page for `scope=all` or a search.
    
</dd>
</dl>

<dl>
<dd>

**$q:** `?string` — Search words matched by meaning, most relevant first. With `scope=similar` only those brands' emails are searched. A search is paged.
    
</dd>
</dl>

<dl>
<dd>

**$scope:** `?string` — `similar` (default) lists emails from the gallery brands most like you; `all` lists the whole gallery for the kind, a page at a time.
    
</dd>
</dl>

<dl>
<dd>

**$subtype:** `?string` — For `scope=similar` without `q`, a gallery subtype to list first, such as `password_reset`. Ignored when it does not belong to the kind.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;listGalleryBrandRequests() -> ?ListGalleryBrandRequestsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists your requests to add brands (usually competitors) to the Sequenzy email gallery, newest first, with where each one stands. A request moves from `requested` to `collecting` once the brand is added to the gallery, then to `available` once its emails are in the gallery, when `brand.url` links to them and [List Email References](/api-reference/references/list) can return them. Requests are private to your company. Requires `templates:read`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->listGalleryBrandRequests();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;listGalleryWatchlist() -> ?ListGalleryWatchlistResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the brands your company watches, usually competitors, newest watch first. This is the dashboard's **Competitors** page. A brand already in the Sequenzy email gallery is `available`, with how many of its emails are in the gallery and when the newest was sent. Read the emails with [List Watched Brand Emails](/api-reference/references/watchlist-emails). A watch is a brand request, so [List Brand Requests](/api-reference/references/brand-requests-list) returns the same rows. Requires `templates:read`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->listGalleryWatchlist();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;listGalleryWatchlistEmails($request) -> ?ListGalleryWatchlistEmailsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists emails from the brands your company watches, newest sent first, a page at a time. Emails usually arrive a few hours after they are sent. Hidden and removed emails are never included. Requires `templates:read`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->listGalleryWatchlistEmails(
    new ListGalleryWatchlistEmailsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$cursor:** `?string` — `nextCursor` from the previous page, for older emails.
    
</dd>
</dl>

<dl>
<dd>

**$domain:** `?string` — Only this watched brand, by website or domain, such as `linear.app`.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Emails per page.
    
</dd>
</dl>

<dl>
<dd>

**$since:** `?string` — Only emails sent at or after this ISO 8601 date or time, such as `2026-10-01` or `2026-10-01T00:00:00Z`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;unwatchGalleryBrand($id) -> ?UnwatchGalleryBrandResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Stops watching a brand. This also withdraws the brand request with the same ID. The brand stays in the gallery. Requires `templates:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->unwatchGalleryBrand(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;references-&gt;watchGalleryBrand($request) -> ?GalleryWatchResult</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Watches a brand, usually a competitor, by its website. A brand already in the gallery is watched at once with status `available`. Any other brand is requested, the same as [Request a Brand](/api-reference/references/brand-requests-create), and its emails show up once it is added and they are collected. Watching again keeps the one watch (a new `note` replaces the old) and returns 200 with `created` false, so retries never duplicate. Requires `templates:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->references->watchGalleryBrand(
    new WatchGalleryBrandRequest([
        'website' => 'website',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$note:** `?string` — Optional. What you want to see from the brand, such as its onboarding emails.
    
</dd>
</dl>

<dl>
<dd>

**$website:** `string` — The brand's website or domain, such as `competitor.com` or `https://competitor.com/pricing`. It is reduced to the registrable domain. It cannot be your own website.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Segments
<details><summary><code>$client-&gt;segments-&gt;create($request) -> ?CreateSegmentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a saved segment from either flat filters or a nested filter root.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->segments->create(
    [
        'key' => "value",
    ],
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$request:** `mixed` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;segments-&gt;delete($segmentId) -> ?DeleteSegmentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a saved segment. Subscribers matched by the segment are not affected.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->segments->delete(
    'segmentId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$segmentId:** `string` — Segment ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;segments-&gt;getCount($segmentId) -> ?GetCountSegmentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Recalculates the active subscriber count from a saved segment's filters. Matches activeSubscriberCount from listSegments when underlying data is unchanged. Custom-attribute updates sync asynchronously and may take roughly 30–35 seconds or longer to appear, even after an import completes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->segments->getCount(
    'segmentId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$segmentId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;segments-&gt;list() -> ?ListSegmentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists saved segments with counts recalculated from their filters for the authenticated company. subscriberCount includes every status; activeSubscriberCount includes only active subscribers. Custom-attribute updates sync asynchronously and may take roughly 30–35 seconds or longer to appear, even after an import completes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->segments->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;segments-&gt;update($segmentId, $request) -> ?UpdateSegmentsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a saved segment's name or filter definition.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->segments->update(
    'segmentId',
    new UpdateSegmentsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$segmentId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$filterJoinOperator:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$filters:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$root:** `?FilterGroup` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## SenderProfiles
<details><summary><code>$client-&gt;senderProfiles-&gt;delete($id) -> ?DeleteSenderProfilesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently deletes one sender (From) profile. Refuses to delete the company's last sender or a profile used by a live campaign, active sequence (including step-level overrides), or transactional email. Eligible draft and rejected campaigns plus the account default are reassigned to the best remaining sender when needed. Requires companies:manage.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->senderProfiles->delete(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Sender profile ID, from GET /v1/sender-profiles.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;senderProfiles-&gt;list() -> ?ListSenderProfilesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists sender (From) and reply-to profiles, which are the account defaults, and whether each sender address sits on a verified sending domain. SMTP submission sends into Sequenzy; outbound delivery remains Sequenzy-managed through SES or Sequenzy's MTA, so customer-managed SMTP relays are not supported.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->senderProfiles->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;senderProfiles-&gt;update($id, $request) -> ?UpdateSenderProfilesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Renames one sender (From) profile in place. Only the display name changes - the address, its sending domain, and the account-wide default From selection are left untouched, so a display name can be standardized across the several identities one mailbox may carry. To change which profile is the account default instead, use PATCH /v1/companies/{companyId} with senderProfileId. Requires companies:manage.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->senderProfiles->update(
    'id',
    new UpdateSenderProfilesRequest([
        'name' => 'SnapCount',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Sender profile ID, from GET /v1/sender-profiles.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` — New display name. Trimmed before saving.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;senderProfiles-&gt;updateReplyProfile($id, $request) -> ?UpdateReplyProfileResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Renames one reply-to profile in place. Only the display name changes - the address and the account-wide default Reply-To selection are left untouched. Requires companies:manage.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->senderProfiles->updateReplyProfile(
    'id',
    new UpdateReplyProfileRequest([
        'name' => 'SnapCount',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Reply-to profile ID, from GET /v1/sender-profiles.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` — New display name. Trimmed before saving.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## SendingStatus
<details><summary><code>$client-&gt;sendingStatus-&gt;get() -> ?SendingStatus</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns whether company-level sending is active, paused, or suspended, the pause reason, the sender-health counts and thresholds behind it, the automated review state, whether sending can be restored without support, and ordered remediation steps. Call this whenever a send or test send fails for a reason that is not a validation error. Enforcement uses all-time totals from a reset watermark rather than a rolling window, so metricsWindow.expiresAt is always null and waiting does not restore sending. Requires the account:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sendingStatus->get();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sendingStatus-&gt;resume($request) -> ?ResumeSendingStatusResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Restores company-level sending paused by a high permanent-bounce rate, after the cause has been fixed. This is not a bypass - it enforces the same gates as the dashboard and never removes suppressions. For a paused workspace, sending is restored only when selfResume.canSelfResume is true on GET /sending-status, which requires a high_hard_bounce_rate pause, a cleared automated sender-health review, and no admin block. An already-active workspace succeeds as an idempotent no-op with resumed false. On restoration the bounce watermark moves to now and the service attempts to requeue paused campaigns plus due sequence steps. A partial queue handoff still returns the committed active state with recovery guidance in message. Requires the companies:manage scope plus owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sendingStatus->resume(
    new ResumeSendingStatusRequest([
        'listSanitizationConfirmed' => true,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$listSanitizationConfirmed:** `bool` — Must be true. Confirms the source of the invalid addresses is fixed and permanent bounces remain suppressed. Recorded on the account audit trail.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sequences
<details><summary><code>$client-&gt;sequences-&gt;archive($sequenceId) -> ?ArchiveSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Archives a sequence and stops new enrollments.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->archive(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;cancelAudienceEnrollment($sequenceId, $runId) -> ?CancelAudienceEnrollmentSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Cancels a queued run immediately or asks a running run to stop after the batch it is currently enrolling. Contacts already enrolled stay in the sequence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->cancelAudienceEnrollment(
    'sequenceId',
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID.
    
</dd>
</dl>

<dl>
<dd>

**$runId:** `string` — Audience enrollment run ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;cancelEnrollments($sequenceId, $request) -> ?SequenceEnrollmentCancelResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Cancels active or waiting enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->cancelEnrollments(
    'sequenceId',
    new SequenceEnrollmentCancelRequest([
        'cancelAll' => true,
        'dryRun' => false,
        'reason' => 'Lifecycle cutover',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$cancelAll:** `?bool` — Cancel every active or waiting enrollment in the sequence, regardless of how contacts entered it. Use this when segment-triggered enrollments share no entry field value. Defaults to dry run unless dryRun is explicitly false.
    
</dd>
</dl>

<dl>
<dd>

**$dryRun:** `?bool` — When true, returns matching enrollments without cancelling them. cancelAll, subscriberIds, and fieldValues default to dry run unless explicitly false; a single subscriberId cancels immediately.
    
</dd>
</dl>

<dl>
<dd>

**$fieldPath:** `?string` — Dot-path inside the token's stored entry event properties. If omitted, the sequence enrollmentFieldPath is used.
    
</dd>
</dl>

<dl>
<dd>

**$fieldValues:** `?array` — Entry field values to match.
    
</dd>
</dl>

<dl>
<dd>

**$reason:** `?string` — Optional reason stored on cancelled enrollment tokens.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Subscriber ID to cancel in this sequence.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberIds:** `?array` — Up to 500 subscriber IDs to cancel in this sequence. IDs that do not resolve are returned in target.notFoundSubscriberIds. Defaults to dry run unless dryRun is explicitly false.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;checkStep($sequenceId, $nodeId, $request) -> ?CheckEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Run the pre-send email check on a saved sequence email step: the same rules as the editor's email checker, plus live verification of every link and image, including links in every A/B variant and translation unless variantId or locale pins one version. Read-only: this never sends or modifies anything, and uses POST only so personalization input can travel in a request body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->checkStep(
    'sequenceId',
    'nodeId',
    new CheckStepSequencesRequest([
        'body' => new CheckEmailRequest([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$nodeId:** `string` — Email step node ID
    
</dd>
</dl>

<dl>
<dd>

**$request:** `CheckEmailRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;configureInboundWebhook($sequenceId, $request) -> ?ConfigureInboundWebhookSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates or updates the endpoint attached to an inbound_webhook trigger. On first setup, omitted fields use catalog/custom integration defaults; on later calls, omitted fields keep their saved values. Use null to clear a saved mapping or sample.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->configureInboundWebhook(
    'sequenceId',
    new ConfigureInboundWebhookSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$fieldMapping:** `?SequenceInboundWebhookFieldMapping` 
    
</dd>
</dl>

<dl>
<dd>

**$samplePayload:** `?array` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;create($request) -> ?SequenceCreateResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a draft automation sequence using AI-generated content, explicit email/action steps, or a blank trigger-to-completion graph when both are omitted. Discount action steps dynamically generate Stripe or Shopify codes that later emails can reference with discount merge tags. Marketer account keys must choose existing sender and Reply-To profiles; requests requiring new profiles return 400 before creating profiles, labels, or campaign/sequence changes, including nested steps and branches.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->create(
    new SequenceCreateRequest([
        'name' => 'Cancellation feedback',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$bccEmails:** `?array` — Addresses blind-copied on every sequence email.
    
</dd>
</dl>

<dl>
<dd>

**$customIntegration:** `?array` — Custom inbound-webhook integration metadata.
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` — Optional dashboard description.
    
</dd>
</dl>

<dl>
<dd>

**$durationDays:** `?float` — Total duration in days used to space AI-generated emails. Omit this to use the default sequence delay schedule.
    
</dd>
</dl>

<dl>
<dd>

**$emailCount:** `?float` — Number of emails for AI-generated content. Defaults to 5. Maximum is 10.
    
</dd>
</dl>

<dl>
<dd>

**$emailStyle:** `?string` — Style for the AI-generated emails: visual (designed, with heroes/imagery/rich sections) or plain (personal, text-first notes with a single button). Defaults to the company's saved preference when omitted.
    
</dd>
</dl>

<dl>
<dd>

**$enrollmentFieldPath:** `?string` — Scalar dot-path event property used by matching_field enrollment, such as order.id or product.providerVariantId. Array traversal with [] is not supported; use propertyFilters for array matching. Applies to event_received and inbound_webhook triggers. Leave empty for built-in Shopify product/variant defaults.
    
</dd>
</dl>

<dl>
<dd>

**$enrollmentMode:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$eventName:** `?string` — Event name for event_received, inbound_webhook, inactivity, and frequency triggers.
    
</dd>
</dl>

<dl>
<dd>

**$frequencyCapEnabled:** `?bool` — Whether the sequence respects the company frequency cap (`/frequency-cap`). When true, an email step is skipped for a contact who already received the cap's number of campaign or marketing sequence emails in its window, and the contact continues to the next step. Transactional steps are never skipped and transactional emails never count. Has no effect until a cap is set.
    
</dd>
</dl>

<dl>
<dd>

**$fromEmail:** `?string` — From address for every email in this sequence. Its domain must be configured and verified.
    
</dd>
</dl>

<dl>
<dd>

**$fromName:** `?string` — Display name recipients see, e.g. 'Brennon at TradeTally'. Selects the sender identity of that name on fromEmail, creating it when the address has no identity by that name; the mailbox's other display names, and everything pinned to them, are untouched. Requires fromEmail; omit it when using senderProfileId, which already carries its own display name.
    
</dd>
</dl>

<dl>
<dd>

**$goal:** `?string` — Goal for AI-generated sequence content. Provide either goal or steps, or omit both for a blank dashboard-compatible draft.
    
</dd>
</dl>

<dl>
<dd>

**$inactiveDays:** `?float` — Days of inactivity before the sequence starts.
    
</dd>
</dl>

<dl>
<dd>

**$inactivityBaseline:** `?string` — For inactivity triggers, controls when to start counting for subscribers who have never performed the event. Defaults to sequence_created_at.
    
</dd>
</dl>

<dl>
<dd>

**$integrationEventKey:** `?string` — Integration event key for inbound_webhook triggers.
    
</dd>
</dl>

<dl>
<dd>

**$integrationSlug:** `?string` — Integration slug for inbound_webhook triggers.
    
</dd>
</dl>

<dl>
<dd>

**$keyDates:** `?SequenceKeyDates` — Named absolute moments for waitUntilKeyDate steps. Null clears them.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Dashboard label names. Missing labels are created.
    
</dd>
</dl>

<dl>
<dd>

**$listId:** `?string` — List ID for contact_added triggers. Omit it to use listScope instead. Use listIds to trigger on several lists.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Several list IDs for a contact_added trigger. A contact joining ANY of them enrolls. Takes precedence over listId when both are sent. Cannot be combined with listScope.
    
</dd>
</dl>

<dl>
<dd>

**$listScope:** `?string` — For contact_added triggers with no list at all. `any_contact` (the default) enrolls every contact added, including contacts that join no list - which is what integrations create when list targeting is empty. `any_list` waits until the contact joins a list. Cannot be combined with listId or listIds.
    
</dd>
</dl>

<dl>
<dd>

**$minCount:** `?float` — Minimum event count for frequency triggers.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$propertyFilters:** `?array` — Event property filters for event_received and inbound_webhook triggers. The sequence only starts when the triggering event's properties match all filters. Use [] in the path to match items inside arrays.
    
</dd>
</dl>

<dl>
<dd>

**$replyProfileId:** `?string` — Existing reply profile ID. It already supplies both the Reply-To address and display name, so send it on its own and omit replyTo and replyToName.
    
</dd>
</dl>

<dl>
<dd>

**$replyTo:** `?string` — Reply-To address for every email in this sequence. A profile is created when needed.
    
</dd>
</dl>

<dl>
<dd>

**$replyToName:** `?string` — Display name for the Reply-To address. Requires replyTo; omit it when using replyProfileId, which already carries its own display name. An address carries one Reply-To name company-wide, so if replyTo already has a saved profile under a different name, that saved name is kept and the response `warnings` array says so.
    
</dd>
</dl>

<dl>
<dd>

**$segmentId:** `?string` — Segment ID for segment_entered and segment_exited triggers.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName. To keep this profile under a different display name, set fromName on the email steps instead, where it is a per-step override.
    
</dd>
</dl>

<dl>
<dd>

**$sendingWindow:** `?SequenceSendingWindow` 
    
</dd>
</dl>

<dl>
<dd>

**$steps:** `?array` — Explicit email and action steps. Provide either steps or goal, or omit both for a blank dashboard-compatible draft.
    
</dd>
</dl>

<dl>
<dd>

**$stopCondition:** `?SequenceStopCondition` 
    
</dd>
</dl>

<dl>
<dd>

**$stopOnSegmentExit:** `?bool` — For segment_entered triggers, cancel enrollment when the subscriber leaves the segment.
    
</dd>
</dl>

<dl>
<dd>

**$tagName:** `?string` — Tag name for tag_added triggers. Use tagNames to trigger on several tags.
    
</dd>
</dl>

<dl>
<dd>

**$tagNames:** `?array` — Several tag names for a tag_added trigger. Receiving ANY of them enrolls the contact. Takes precedence over tagName when both are sent.
    
</dd>
</dl>

<dl>
<dd>

**$timeWindowDays:** `?float` — Time window in days for frequency triggers.
    
</dd>
</dl>

<dl>
<dd>

**$trigger:** `?string` — Defaults to contact_added when omitted.
    
</dd>
</dl>

<dl>
<dd>

**$userCancellable:** `?bool` — Whether recipients can cancel this sequence from email preferences.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;createFromExample($request) -> ?CreateFromExampleSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Clones a public sequence from the Sequenzy email gallery into a draft sequence for your company. The draft keeps the example's trigger family and send timing, up to 12 emails (the first 12 unless `stepNumbers` picks which), and AI then writes every email in your brand in the background (usually 30 to 60 seconds). Poll [Get Sequence](/api-reference/sequences/get) until `enrichmentStatus` is `complete`. The sequence sends nothing until you enable it. Every successful call creates another sequence, so do not retry after a success. Requires `sequences:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->createFromExample(
    new CreateFromExampleSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$brand:** `?string` — Gallery brand slug. Use with `sequence` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$brief:** `?string` — Optional direction applied to every email. Takes priority over the example.
    
</dd>
</dl>

<dl>
<dd>

**$emailStyle:** `?string` — Generated email style. Defaults to the company's email style preference.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Sequence name. Defaults to the sequence type, such as "Onboarding sequence".
    
</dd>
</dl>

<dl>
<dd>

**$sequence:** `?string` — Gallery sequence slug. Use with `brand` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$stepNumbers:** `?array` — Which of the example's emails to clone, as 1-based positions in the gallery sequence (its Email 1, Email 2 and so on), not the `stepNumber` of the created sequence's steps. Duplicates are ignored and order does not matter. Each email keeps its original timing from the trigger. Defaults to the first 12. An empty list, more than 12 distinct positions, or a position outside the sequence returns 400; a list of more than 100 entries or non-integer entries fails validation with 422.
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Gallery sequence page URL, such as `https://sequenzy.com/email-examples/brands/linear/sequences/onboarding`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;createGoal($sequenceId, $request) -> ?CreateGoalSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a conversion goal for an event, subscriber attribute change, or applied tag.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->createGoal(
    'sequenceId',
    new CreateGoalSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;delete($sequenceId) -> ?SequenceActionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a sequence and its automation nodes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->delete(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;deleteGoal($sequenceId, $goalId) -> ?DeleteGoalSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently removes a conversion goal from the sequence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->deleteGoal(
    'sequenceId',
    'goalId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$goalId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;disable($sequenceId) -> ?SequenceActionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Pauses a sequence, blocks new enrollments, and holds workflow execution until the sequence is enabled again.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->disable(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;duplicate($sequenceId, $request) -> ?DuplicateSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an independent draft copy of the sequence graph, email templates, and sequence A/B tests.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->duplicate(
    'sequenceId',
    new DuplicateSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Optional name for the copy.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;enable($sequenceId) -> ?SequenceActionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Activates a sequence and opens it for new enrollments. Activation enforces the same readiness checks returned by simulateSequence; invalid triggers, incomplete steps, disconnected graphs, and archived sequences are rejected without changing status. If it was paused, held subscribers continue from their current step and due waits are queued gradually.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->enable(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;enrollAudience($sequenceId, $request) -> ?EnrollAudienceSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active or waiting in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->enrollAudience(
    'sequenceId',
    new EnrollAudienceSequencesRequest([
        'audience' => new SequenceAudience([
            'type' => SequenceAudienceType::All->value,
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID.
    
</dd>
</dl>

<dl>
<dd>

**$audience:** `SequenceAudience` 
    
</dd>
</dl>

<dl>
<dd>

**$data:** `?array` — Run-level data shared by everyone in this run (a sale end time, a discount percentage, a cut-off time). Stored on the run and copied into every enrolled contact's sequence context at enrollment time; the sequence's emails and conditions read it as `{{enrollment.<field>}}` (nested paths like `{{enrollment.draw.date}}` work). Must be a JSON object of at most 8 KB, 100 top-level keys and 8 levels of nesting; keys named __proto__, constructor or prototype and strings containing NUL characters are rejected. Omit, null or {} for none. Auto-enroll syncs do not carry run data.
    
</dd>
</dl>

<dl>
<dd>

**$scheduledFor:** `?DateTime` — Start the run at this moment instead of now (up to one year ahead). The run is created queued with a delayed job and can be cancelled before it starts. A past value starts now.
    
</dd>
</dl>

<dl>
<dd>

**$targetNodeId:** `?string` — Step to start contacts at. Defaults to the first step after the trigger. Cannot be a trigger node.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;enrollSubscribersIn($sequenceId, $request) -> ?EnrollSubscribersInSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Manually enrolls active subscribers into a sequence by email or subscriber ID, starting at the first step or a specific node.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->enrollSubscribersIn(
    'sequenceId',
    new EnrollSubscribersInSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID.
    
</dd>
</dl>

<dl>
<dd>

**$emails:** `?array` — Subscriber emails to enroll. Combined with subscriberIds, up to 500 per request.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberIds:** `?array` — Subscriber IDs to enroll. Combined with emails, up to 500 per request.
    
</dd>
</dl>

<dl>
<dd>

**$targetNodeId:** `?string` — Node to start enrollment at. Defaults to the first step after the trigger. Cannot be a trigger node.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;estimateAudienceEnrollment($sequenceId, $request) -> ?EstimateAudienceEnrollmentSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Counts the contacts matching an audience and how many of them would be enrolled. Contacts already in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before. Nothing is changed.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->estimateAudienceEnrollment(
    'sequenceId',
    new EstimateAudienceEnrollmentSequencesRequest([
        'audience' => new SequenceAudience([
            'type' => SequenceAudienceType::All->value,
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID.
    
</dd>
</dl>

<dl>
<dd>

**$audience:** `SequenceAudience` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;generate($request) -> ?GenerateSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deprecated compatibility alias that creates and persists a disabled contact_added sequence draft from a goal. Use POST /sequences for new integrations.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->generate(
    new GenerateSequencesRequest([
        'goal' => 'Onboard a new workspace admin',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$durationDays:** `?float` — Duration used to space suggested delays. Defaults to 14.
    
</dd>
</dl>

<dl>
<dd>

**$emailCount:** `?float` — Number of emails to generate. Defaults to 5. Maximum is 10.
    
</dd>
</dl>

<dl>
<dd>

**$goal:** `string` — Sequence goal or desired subscriber journey.
    
</dd>
</dl>

<dl>
<dd>

**$listId:** `?string` — Optional list ID that scopes the contact_added trigger.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Optional sequence name. Defaults to the normalized goal.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;get($sequenceId) -> ?GetSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns sequence metadata, nodes, and editable email steps.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->get(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;getAudienceEnrollment($sequenceId, $runId) -> ?GetAudienceEnrollmentSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Status and counters of one audience enrollment run. Poll this while status is queued or running.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->getAudienceEnrollment(
    'sequenceId',
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID.
    
</dd>
</dl>

<dl>
<dd>

**$runId:** `string` — Audience enrollment run ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;getEnrollment($sequenceId, $enrollmentId) -> ?SequenceEnrollmentGetResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Reads one enrollment token, including how it entered, which branches it already took, and the bounded recorded graph walk from ClickHouse. Use this when list enrollments shows a completed token with enteredVia unknown or sitting on the completion node and you need to know why the first branch took its else path. Compared values are summaries (missing, empty, nonempty, equals_expected), never the raw field or event-property value. Legacy node-completion metadata that stored an unredacted evaluation reason is redacted on read. Check nodeHistoryTruncated and branchDecisionsTruncated before treating either history as complete.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->getEnrollment(
    'sequenceId',
    'enrollmentId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$enrollmentId:** `string` — Enrollment token ID from list sequence enrollments (enrollmentId).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;getEnrollmentRealignment($sequenceId, $jobId) -> ?SequenceEnrollmentRealignJobResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the state of an applied realignment job. When status is completed, result contains the bounded realignment result and any continuation cursor.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->getEnrollmentRealignment(
    'sequenceId',
    'jobId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$jobId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;getInboundWebhook($sequenceId) -> ?GetInboundWebhookSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the endpoint configuration attached to an inbound_webhook trigger.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->getInboundWebhook(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;getStats($sequenceId, $request) -> ?GetStatsSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns aggregated engagement metrics plus a live active/waiting enrollment breakdown by current node for a specific sequence. This is an alias for /metrics/sequences/{sequenceId}.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->getStats(
    'sequenceId',
    new GetStatsSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$end:** `?DateTime` — End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events.
    
</dd>
</dl>

<dl>
<dd>

**$period:** `?string` — Sliding time window. Ignored when `start` and `end` are provided.
    
</dd>
</dl>

<dl>
<dd>

**$start:** `?DateTime` — Start of custom time range (ISO 8601). Must be used with `end`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;getTestRun($sequenceId, $runId) -> ?SequenceTestRunResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Read status and step logs for a same-company sequence test run. Requires sequences:read and subscribers:read.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->getTestRun(
    'sequenceId',
    'runId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$runId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;list($request) -> ?ListSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns matching automation sequences, newest first. Omit limit and offset to return all matches; either parameter enables pagination (default page size 50, capped at 100).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->list(
    new ListSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$label:** `?string` — Alias for labels. Takes precedence if both are present.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?string` — Comma-separated dashboard label names. The label alias is also accepted.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Page size, up to 100. When limit and offset are both omitted, every sequence is returned.
    
</dd>
</dl>

<dl>
<dd>

**$offset:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` — Case-insensitive name or description search.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;listAudienceEnrollments($sequenceId, $request) -> ?ListAudienceEnrollmentsSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Recent audience enrollment runs for a sequence, newest first, with their status and counters.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->listAudienceEnrollments(
    'sequenceId',
    new ListAudienceEnrollmentsSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Runs to return.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;listEnrollments($sequenceId, $request) -> ?SequenceEnrollmentListResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active and waiting enrollments. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->listEnrollments(
    'sequenceId',
    new ListEnrollmentsSequencesRequest([
        'currentNodeId' => 'node_wave_1',
        'email' => 'customer@example.com',
        'status' => 'waiting',
        'subscriberId' => 'sub_abc123',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$currentNodeId:** `?string` — Comma-separated sequence node IDs. Only enrollments currently sitting on one of these nodes are returned.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Exact email address to match, case-insensitive.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Enrollments per page. Values above 500 are capped, and above 100 when stopConditionMatch is true.
    
</dd>
</dl>

<dl>
<dd>

**$offset:** `?int` — Number of enrollments to skip. Page until pagination.hasMore is false.
    
</dd>
</dl>

<dl>
<dd>

**$sort:** `?string` — Result order. Defaults to enrolled_at_desc. Enrollments with no scheduled resume sort last under wait_until ordering.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Comma-separated enrollment statuses: active, waiting, completed, failed, cancelled. Defaults to active,waiting.
    
</dd>
</dl>

<dl>
<dd>

**$stopConditionMatch:** `?bool` — Annotate each returned active or waiting enrollment with whether the sequence stop condition already matches for that contact right now. Stop conditions are re-evaluated when an enrollment next runs a step, not when their event arrives, so a stopped contact keeps reporting waiting until its delay expires. Use this to confirm a stop event registered without waiting the delay out. Caps the page at 100 regardless of limit.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Comma-separated subscriber IDs.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;listGoals($sequenceId) -> ?ListGoalsSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the conversion goals configured for a sequence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->listGoals(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;moveEnrollments($sequenceId, $request) -> ?SequenceEnrollmentMoveResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Releases a bounded batch of contacts off one sequence step and onto another, keeping their existing enrollment, entry event properties, and stop-condition snapshots. Moved contacts become active on the target step immediately. Defaults to a dry run; each call is capped at 500 and is never drained automatically, so repeat the request while remainingCount is above zero. Works while new enrollment is paused, because the contacts are already enrolled.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->moveEnrollments(
    'sequenceId',
    new SequenceEnrollmentMoveRequest([
        'fromNodeId' => 'node_delay_2',
        'limit' => 180,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$dailyLimit:** `?float` — Refuses to move more than this many enrollments onto targetNodeId in a rolling 24 hours, counting the moves recorded by earlier calls.
    
</dd>
</dl>

<dl>
<dd>

**$dryRun:** `?bool` — When true (the default), reports which enrollments would move without moving them.
    
</dd>
</dl>

<dl>
<dd>

**$fromNodeId:** `string` — Node ID the contacts are currently sitting on, such as the delay step they are waiting at.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?float` — Maximum enrollments to move in this call. Defaults to 100, maximum 500.
    
</dd>
</dl>

<dl>
<dd>

**$reason:** `?string` — Note stored on every moved enrollment and returned as moveReason when listing enrollments.
    
</dd>
</dl>

<dl>
<dd>

**$sort:** `?string` — Which enrollments to take first. Defaults to wait_until_asc, the contacts that have been waiting longest for their next step.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberIds:** `?array` — Optional narrowing filter. Only move these subscribers, up to 500.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?array` — Existing tag names applied to the moved contacts. Requires the subscribers:tag scope. Applying them never enrolls contacts in tag_added sequences.
    
</dd>
</dl>

<dl>
<dd>

**$targetNodeId:** `?string` — Node ID to move them onto. Defaults to the source step's only next step, and is required when that step branches or is terminal. Cannot be the trigger node.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;pauseEnrollments($sequenceId) -> ?SequenceActionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Stops new subscribers from entering an active sequence while current recipients continue through the sequence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->pauseEnrollments(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;previewFromExample($request) -> ?PreviewFromExampleSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Rewrites the first 3 emails of a public gallery sequence for your brand, or for another `website`, and returns them without creating anything. Emails that could not be written are counted in `failedEmailCount`; the call fails only when none could be written. Usually takes 10 to 30 seconds. Requires `sequences:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->previewFromExample(
    new PreviewFromExampleSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$brand:** `?string` — Gallery brand slug. Use with `sequence` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$brief:** `?string` — Optional direction for every email. Takes priority over the example.
    
</dd>
</dl>

<dl>
<dd>

**$sequence:** `?string` — Gallery sequence slug. Use with `brand` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Gallery sequence page URL.
    
</dd>
</dl>

<dl>
<dd>

**$website:** `?string` — Optional site or domain, such as `acme.com`, to write the preview for instead of your own brand. Its registrable domain is looked up like the public gallery preview. Omit it to use your company's brand profile.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;realignEnrollments($sequenceId, $request) -> ?SequenceEnrollmentRealignResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Pulls waiting enrollments forward to the start of the sequence sending window on the day they are already scheduled for. Changing a sending window leaves existing waits alone, so a widened window never reaches contacts already parked on an email-bound delay step and a narrowed one defers them to the next allowed day. Sequence windows never advance SMS, webhooks, branches, or other non-email actions. A wait only ever moves earlier, never onto a different local day, and never before now. Nobody is cancelled or re-enrolled. Defaults to a synchronous dry run; set dryRun false to queue a background apply job, then poll its status endpoint. Each job is capped at 1000 enrollments; when the completed result has hasMore true, pass nextCursor as cursor on the next request.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->realignEnrollments(
    'sequenceId',
    new SequenceEnrollmentRealignRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$cursor:** `?string` — Opaque continuation cursor. When a response has hasMore true, pass its nextCursor here to continue after the enrollments already scanned.
    
</dd>
</dl>

<dl>
<dd>

**$dryRun:** `?bool` — When true (the default), returns the new wait times without writing them. Set false to apply.
    
</dd>
</dl>

<dl>
<dd>

**$nodeIds:** `?array` — Step IDs to limit realignment to. Defaults to every step.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberIds:** `?array` — Up to 500 subscriber IDs to limit realignment to. Defaults to every waiting contact.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;renderStep($sequenceId, $nodeId, $request) -> ?RenderEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Render one sequence email step to the exact email-safe HTML that would be sent, for embedding a visual preview. Read-only: this never sends or modifies anything, and uses POST only so personalization input can travel in a request body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->renderStep(
    'sequenceId',
    'nodeId',
    new RenderStepSequencesRequest([
        'body' => new RenderEmailRequest([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$nodeId:** `string` — Email step node ID
    
</dd>
</dl>

<dl>
<dd>

**$request:** `RenderEmailRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;resumeEnrollments($sequenceId) -> ?SequenceActionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Reopens new enrollments for an active sequence whose enrollment gate was paused. Use enableSequence for a fully disabled sequence.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->resumeEnrollments(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;rotateInboundWebhookSecret($sequenceId) -> ?RotateInboundWebhookSecretSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Immediately invalidates the previous URL and returns the replacement endpoint.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->rotateInboundWebhookSecret(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;sendTestEmail($sequenceId, $nodeId, $request) -> ?SendTestEmailSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a real test email for one saved action_email sequence step to one or more internal reviewers. action_ab_test steps are not supported; inspect their variants on the sequence detail emails[].abTest.variants payload. The sequence is not activated and no subscribers are enrolled. Returns one durable email send ID per recipient for delivery inspection.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->sendTestEmail(
    'sequenceId',
    'nodeId',
    new SendTestEmailSequencesRequest([
        'recipients' => [
            'recipients',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID containing the email step.
    
</dd>
</dl>

<dl>
<dd>

**$nodeId:** `string` — action_email step node ID returned by the sequence detail endpoint. Do not pass an action_ab_test node.
    
</dd>
</dl>

<dl>
<dd>

**$recipients:** `array` — Internal reviewer email addresses. Duplicate addresses are sent only once.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;simulate($sequenceId, $request) -> ?SimulateSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Dry-runs a sequence without sending mail or enrolling anyone. Activating does not auto-enroll anyone. Without a subscriber this reports who currently matches and activation readiness errors. Pass subscriberId or email to also walk that stored contact's branch path. Always requires both sequences:read and subscribers:read because results include contact samples.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->simulate(
    'sequenceId',
    new SimulateSequencesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Optional stored subscriber email to walk through the graph. Do not pass with subscriberId.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — How many currently matching contacts to include in the sample. Defaults to 10, maximum 25.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `?string` — Optional stored subscriber to walk through the graph. Do not pass with email.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;startTestRun($sequenceId, $request) -> ?SequenceTestRunResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Runs real sequence actions for one active subscriber. Emails are marked as tests. Requires sequences:activate and subscribers:read. Does not enable the sequence or record a trigger event. Ordinary failure retries are disabled; stalled-job recovery can replay actions after worker loss. Completed side effects are not rolled back. Inspect before starting another run.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->startTestRun(
    'sequenceId',
    new StartTestRunSequencesRequest([
        'subscriberId' => 'subscriberId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$customVariables:** `?array` — Trigger event properties available as event.* in sequence actions. Supports nested objects and arrays. Omit or use an empty object for no event properties. Null is invalid. No event is recorded and subscriber attributes are not changed by supplying this object.
    
</dd>
</dl>

<dl>
<dd>

**$speedMultiplier:** `?int` — Delay acceleration. Existing live-test wait caps still apply.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberId:** `string` — Active subscriber in the same company with an email address.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;unarchive($sequenceId) -> ?UnarchiveSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Restores an archived sequence as a disabled draft for review.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->unarchive(
    'sequenceId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;update($sequenceId, $request) -> ?UpdateSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates sequence settings and content, inserts linear or branching steps, or performs revision-guarded graph edits. Marketer account keys must choose existing sender and Reply-To profiles; requests requiring new profiles return 400 before creating profiles, labels, or campaign/sequence changes, including nested steps and branches.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->update(
    'sequenceId',
    new SequenceUpdateRequest([
        'name' => 'Updated Welcome Sequence',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` — Sequence ID
    
</dd>
</dl>

<dl>
<dd>

**$audienceAutoEnroll:** `?SequenceAudienceAutoEnroll` — Keep enrolling later joiners of an audience until the last key date. Null clears it. Changing the trigger away from manual switches it off (endedReason "disabled").
    
</dd>
</dl>

<dl>
<dd>

**$bccEmails:** `?array` — Email addresses that receive a blind copy of every email this sequence sends, such as a customer support inbox (max 10). Set to null to remove them.
    
</dd>
</dl>

<dl>
<dd>

**$branch:** `?SequenceBranchInput` 
    
</dd>
</dl>

<dl>
<dd>

**$confirmLiveChange:** `?bool` — Required for trigger replacement or nodeUpdates on an active sequence. Set true only after confirming that the edits can affect recipients who reach those nodes in the future.
    
</dd>
</dl>

<dl>
<dd>

**$confirmStructuralChange:** `?bool` — Required when inserting steps or branches, or editing the graph of an active sequence. Set true only after confirming the live-flow impact for current and future recipients.
    
</dd>
</dl>

<dl>
<dd>

**$customIntegration:** `?array` — Custom integration descriptor for an inbound_webhook trigger.
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` — Updated dashboard description.
    
</dd>
</dl>

<dl>
<dd>

**$emails:** `?array` — Existing email step updates. Provide either emails or steps. Items without nodeId or emailId are matched by existing step order and do not create new steps.
    
</dd>
</dl>

<dl>
<dd>

**$enrollmentFieldPath:** `?string` — Scalar dot-path event property used by matching_field enrollment on event_received and inbound_webhook sequences. Array traversal with [] is not supported; use propertyFilters for array matching. Set to null to use built-in defaults.
    
</dd>
</dl>

<dl>
<dd>

**$enrollmentMode:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$enrollmentPaused:** `?bool` — Set true to stop new enrollments for an active sequence while current recipients continue. Set false to resume new enrollments.
    
</dd>
</dl>

<dl>
<dd>

**$eventName:** `?string` — Event name for event_received, inbound_webhook, inactivity, or frequency triggers.
    
</dd>
</dl>

<dl>
<dd>

**$frequencyCapEnabled:** `?bool` — Whether the sequence respects the company frequency cap (`/frequency-cap`). When true, an email step is skipped for a contact already at the cap, and the contact continues to the next step. Transactional steps are never skipped. Omit to leave it unchanged.
    
</dd>
</dl>

<dl>
<dd>

**$fromEmail:** `?string` — From address for every email in this sequence. Its domain must be configured and verified.
    
</dd>
</dl>

<dl>
<dd>

**$fromName:** `?string` — Display name recipients see, e.g. 'Brennon at TradeTally'. Selects the sender identity of that name on fromEmail, creating it when the address has no identity by that name; the mailbox's other display names, and everything pinned to them, are untouched. Requires fromEmail; omit it when using senderProfileId, which already carries its own display name.
    
</dd>
</dl>

<dl>
<dd>

**$graphEdit:** `?SequenceGraphEditInput` 
    
</dd>
</dl>

<dl>
<dd>

**$inactiveDays:** `?float` 
    
</dd>
</dl>

<dl>
<dd>

**$inactivityBaseline:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$insertSteps:** `?SequenceLinearStepInsertionInput` 
    
</dd>
</dl>

<dl>
<dd>

**$integrationEventKey:** `?string` — Catalog event key for an inbound_webhook trigger.
    
</dd>
</dl>

<dl>
<dd>

**$integrationSlug:** `?string` — Catalog integration slug for an inbound_webhook trigger.
    
</dd>
</dl>

<dl>
<dd>

**$keyDates:** `?SequenceKeyDates` — Replace the sequence key dates. Contacts already waiting on a key-date step are re-scheduled to the new dates. Set to null to remove them (rejected while a step still waits for one).
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Replacement dashboard label names. Missing labels are created.
    
</dd>
</dl>

<dl>
<dd>

**$listId:** `?string` — List ID for a replacement contact_added trigger.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Several list IDs for a replacement contact_added trigger. A contact joining ANY of them enrolls. Cannot be combined with listScope.
    
</dd>
</dl>

<dl>
<dd>

**$listScope:** `?string` — For a replacement contact_added trigger with no list. `any_contact` (the default) enrolls every contact added, even one that joins no list; `any_list` waits for a list membership. Cannot be combined with listId or listIds.
    
</dd>
</dl>

<dl>
<dd>

**$minCount:** `?float` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Updated sequence name.
    
</dd>
</dl>

<dl>
<dd>

**$nodeUpdates:** `?array` — Atomic, type-aware patches for existing sequence nodes. A node may appear only once, and either every patch commits or none do.
    
</dd>
</dl>

<dl>
<dd>

**$propertyFilters:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$replyProfileId:** `?string` — Existing reply profile ID. It already supplies both the Reply-To address and display name, so send it on its own and omit replyTo and replyToName.
    
</dd>
</dl>

<dl>
<dd>

**$replyTo:** `?string` — Reply-To address for every email in this sequence.
    
</dd>
</dl>

<dl>
<dd>

**$replyToName:** `?string` — Display name for the Reply-To address. Requires replyTo; omit it when using replyProfileId, which already carries its own display name. An address carries one Reply-To name company-wide, so if replyTo already has a saved profile under a different name, that saved name is kept and the response `warnings` array says so.
    
</dd>
</dl>

<dl>
<dd>

**$segmentId:** `?string` — Segment ID for a replacement segment_entered or segment_exited trigger.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName. To keep this profile under a different display name, set fromName on the email steps instead, where it is a per-step override.
    
</dd>
</dl>

<dl>
<dd>

**$sendingWindow:** `?SequenceSendingWindow` 
    
</dd>
</dl>

<dl>
<dd>

**$smsSteps:** `?array` — Content updates for existing SMS steps, targeted by action_sms nodeId. Content-only edits; use insertSteps to create new SMS steps.
    
</dd>
</dl>

<dl>
<dd>

**$steps:** `?array` — Alias for emails. Use insertSteps to create new steps.
    
</dd>
</dl>

<dl>
<dd>

**$stopCondition:** `?SequenceStopCondition` 
    
</dd>
</dl>

<dl>
<dd>

**$stopOnSegmentExit:** `?bool` — Stop active enrollments when a contact leaves the replacement trigger segment.
    
</dd>
</dl>

<dl>
<dd>

**$subscriberUpdateSteps:** `?array` — Full config replacements for existing action_update_attributes steps, targeted by nodeId.
    
</dd>
</dl>

<dl>
<dd>

**$tagName:** `?string` — Tag name for a replacement tag_added trigger.
    
</dd>
</dl>

<dl>
<dd>

**$tagNames:** `?array` — Several tag names for a replacement tag_added trigger. Receiving ANY of them enrolls the contact.
    
</dd>
</dl>

<dl>
<dd>

**$timeWindowDays:** `?float` 
    
</dd>
</dl>

<dl>
<dd>

**$trigger:** `?string` — Atomically replaces the current trigger. Include its typed configuration fields in the same request. Active sequences require confirmLiveChange.
    
</dd>
</dl>

<dl>
<dd>

**$userCancellable:** `?bool` — Whether recipients can cancel this sequence from email preferences.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sequences-&gt;updateGoal($sequenceId, $goalId, $request) -> ?UpdateGoalSequencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replaces the editable configuration for an existing sequence goal.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sequences->updateGoal(
    'sequenceId',
    'goalId',
    new UpdateGoalSequencesRequest([
        'body' => new SequenceGoalInput([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sequenceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$goalId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$request:** `SequenceGoalInput` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Shopify
<details><summary><code>$client-&gt;shopify-&gt;getAutomationSettings() -> ?GetAutomationSettingsShopifyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the connected Shopify store's browse-abandonment, cart-abandonment, and price-drop automation settings, with platform defaults applied where the store hasn't overridden them.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->shopify->getAutomationSettings();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;shopify-&gt;updateAutomationSettings($request) -> ?UpdateAutomationSettingsShopifyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Partial update of the store's browse-abandonment, cart-abandonment, and/or price-drop settings: omitted sections are untouched, omitted fields keep their current value, and null resets a section to the platform defaults.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->shopify->updateAutomationSettings(
    new UpdateAutomationSettingsShopifyRequest([
        'priceDrop' => new ShopifyPriceDropSettings([
            'minPercent' => 10,
        ]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$browseAbandonment:** `?ShopifyBrowseAbandonmentSettings` 
    
</dd>
</dl>

<dl>
<dd>

**$cartAbandonment:** `?ShopifyCartAbandonmentSettings` 
    
</dd>
</dl>

<dl>
<dd>

**$priceDrop:** `?ShopifyPriceDropSettings` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sms
<details><summary><code>$client-&gt;sms-&gt;getSettings() -> ?GetSettingsSmsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the company's SMS add-on status, including credit balance, phone numbers, and whether SMS sequence steps will actually send.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sms->getSettings();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sms-&gt;getUsage() -> ?GetUsageSmsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Per-number outbound SMS usage for the selected company. Requires account:read. Test sends count only toward testSends, not totalSends, delivered, failed or creditsCharged. lastSentAt may include a test send. Rows are ordered by totalSends descending.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sms->getUsage();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sms-&gt;releaseNumber($numberId) -> ?ReleaseNumberSmsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Release a toll-free number and free its workspace slot. Requires companies:manage. Steps explicitly pinned to this number do not switch to another number. This action cannot reclaim the number after release.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sms->releaseNumber(
    'numberId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$numberId:** `string` — SMS number ID from GET /sms/settings.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sms-&gt;sendTest($request) -> ?SendTestSmsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sends a real test text message. Test sends charge credits, bypass quiet hours, are excluded from step stats, and are limited to 100 per company in a rolling 24-hour window. Requires the SMS add-on with a verified number.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sms->sendTest(
    new SendTestSmsRequest([
        'to' => '+15550100123',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$blocks:** `?array` — SMS content blocks (text + image subset). Provide text or blocks, not both.
    
</dd>
</dl>

<dl>
<dd>

**$fromNumberId:** `?string` — Verified sending number ID from GET /sms/settings. Omit to use the oldest verified company number. An invalid explicit selection returns 400 instead of falling back.
    
</dd>
</dl>

<dl>
<dd>

**$imageUrls:** `?array` — Up to 2 publicly reachable image URLs sent as MMS media (US/CA only).
    
</dd>
</dl>

<dl>
<dd>

**$text:** `?string` — Plain-text message body. Provide text or blocks, not both.
    
</dd>
</dl>

<dl>
<dd>

**$to:** `string` — Destination phone number in international E.164 format.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;sms-&gt;updateNumberLabel($numberId, $request) -> ?UpdateNumberLabelSmsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an SMS number's user-facing label and/or its brand prefix override. Omitted fields keep their value; at least one field is required. Requires companies:manage.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->sms->updateNumberLabel(
    'numberId',
    new UpdateNumberLabelSmsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$numberId:** `string` — SMS number ID returned by Get SMS Settings.
    
</dd>
</dl>

<dl>
<dd>

**$brandPrefix:** `?string` — Per-number brand prefix override; messages send as "{prefix}: your message". Send null to clear it back to the account-wide prefix.
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?string` — Label such as Marketing or Support. Send null to clear it.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Subscribers
<details><summary><code>$client-&gt;subscribers-&gt;addTagsBulk($request) -> ?AddTagsBulkResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds multiple tags to a subscriber. Creates the subscriber if they don't exist. Creates tag definitions if they don't exist. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, the confirmation email is queued, and tag automations wait at their trigger until the subscriber confirms.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->addTagsBulk(
    new AddTagsBulkRequest([
        'tags' => [
            'premium',
            'newsletter',
            'vip',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$customAttributes:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Customer-owned app/customer/user ID
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — First name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Last name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `array` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;bulkAddTags($request) -> ?BulkSubscriberTagResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds one or more tags to up to 500 existing subscribers identified by email, externalId, or subscriberId. Built for reconciling historical or derived tags, so identifiers that do not match an existing subscriber are returned in notFound rather than creating contacts. Tag automations are skipped unless triggerAutomations is true, which requires the automations:trigger scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->bulkAddTags(
    new BulkSubscriberTagRequest([
        'emails' => [
            'one@example.com',
            'two@example.com',
        ],
        'tags' => [
            'derived-churn-risk',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$request:** `BulkSubscriberTagRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;bulkRemoveTags($request) -> ?BulkSubscriberTagResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes one or more tags from up to 500 existing subscribers identified by email, externalId, or subscriberId. Identifiers that do not match an existing subscriber are returned in notFound.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->bulkRemoveTags(
    new BulkSubscriberTagRequest([
        'subscriberIds' => [
            'sub_abc123',
            'sub_def456',
        ],
        'tags' => [
            'derived-churn-risk',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$request:** `BulkSubscriberTagRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;cancelOperation($id) -> ?SubscriberOperationResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires subscribers:read. Tagging and cancelling a tagging task also require subscribers:tag; creating tag definitions requires tags:write; triggering automations requires automations:trigger. Personal keys retain current company role restrictions. Company keys retain company-scoped authority. Workers recheck authority on every page. Cancellation stops future pages and keeps applied tags. An action already in flight may finish; its contact is reported as uncertain. Terminal cancellation is idempotent.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->cancelOperation(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;create($request) -> ?CreateSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a new subscriber or handles existing ones based on the `duplicateStrategy` parameter.

Requires `subscribers:write`, including when supplying a nonempty `lists` array. Explicit sequence enrollment and writes that can send a double opt-in confirmation require `automations:trigger`.

**Duplicate Strategies:**
- `skip` (default): Don't update existing subscribers
- `merge`: Only fill in missing fields, never overwrite existing values
- `overwrite`: Replace all fields (but never reactivate unsubscribed users)
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->create(
    new CreateSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$createdAt:** `?DateTime` — Original signup date, for importing history from another platform. Preserves the real date so date-relative segments are correct immediately. An existing contact's date only ever moves earlier, regardless of duplicateStrategy. Supplying this defaults enrollInSequences to false, and updatedAt is never backdated. New-subscriber account notifications remain eligible when the signup date is at most one hour old; older dates do not notify on creation. Double opt-in confirmation can notify even for imported contacts. Your notification preferences, double opt-in and the daily cap still apply.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 

How to handle existing subscribers:
- `skip`: Don't update existing subscribers (default)
- `merge`: Only fill in missing fields, never overwrite existing values
- `overwrite`: Replace all fields (but never reactivate unsubscribed users)
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Required when creating a new subscriber unless a phone is provided (which creates a phone-only SMS contact). Optional when externalId identifies an existing subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$enrollInSequences:** `?bool` — Whether to enroll the subscriber in matching sequences. Defaults to true for API calls, or to false when createdAt is supplied. Explicitly passing true requires the automations:trigger scope and returns 403 when that scope is missing.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Customer-owned app/customer/user ID. Unique per company when provided.
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$lists:** `?array` — List IDs to add subscriber to, covered by subscribers:write. If not provided, a subscriber this call creates follows the workspace default lists setting and an existing subscriber keeps the memberships they already have, so an attribute-only upsert never changes list membership. If empty array, subscriber is added to NO lists.
    
</dd>
</dl>

<dl>
<dd>

**$optInMode:** `?string` 

Consent handling for this request:
- `default`: obey the company double opt-in setting for new active subscribers; existing unsubscribed contacts are not sent confirmation email
- `confirmed`: create or keep active immediately when you have verified consent
- `double_opt_in`: send a confirmation email and keep the contact unsubscribed until they confirm
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Phone number in E.164 format or national format. Stored normalized to E.164. Invalid values fail with a 400 validation error. Does not affect SMS consent. With no email or externalId, creates or matches a phone-only (SMS) contact.
    
</dd>
</dl>

<dl>
<dd>

**$phoneCountry:** `?string` — ISO 3166-1 alpha-2 country used to read a national-format phone, defaulting to US. A parsing hint only - the stored phoneCountry always comes from the parsed number. Sending it without phone fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$smsConsent:** `?bool` — SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Initial subscriber status.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$timezone:** `?string` — IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Invalid values fail with a 400 validation error; null clears the stored value.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;createImport($request) -> ?CreateImportSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues an asynchronous full-record subscriber import of up to 5,000 contacts.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->createImport(
    new CreateImportSubscribersRequest([
        'subscribers' => [
            new SubscriberImportRecord([]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$defaultPhoneCountry:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$enrollInSequences:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$fileName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$idempotencyKey:** `?string` — Caller-owned key (1-255 characters, not blank) that makes retrying this request safe. The key is scoped to the request content - resending the same request returns the already-queued import with deduplicated true, while different content under the same key queues a new import. A blank key is rejected with 400.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$optInMode:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$smsConsent:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$subscribers:** `array` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;createNote($email, $request) -> ?CreateNoteSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an internal note for a subscriber identified by email address.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->createNote(
    'email',
    new CreateNoteSubscribersRequest([
        'body' => 'body',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — URL-encoded email address
    
</dd>
</dl>

<dl>
<dd>

**$body:** `string` — Internal note body.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;createNoteByExternalId($request) -> ?CreateNoteByExternalIdSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an internal note for a subscriber identified by customer-owned external ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->createNoteByExternalId(
    new CreateNoteByExternalIdSubscribersRequest([
        'externalId' => 'externalId',
        'body' => 'body',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — External ID. Query form supports IDs containing slashes.
    
</dd>
</dl>

<dl>
<dd>

**$body:** `string` — Internal note body.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;delete($email) -> ?DeleteSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a subscriber by their email address.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->delete(
    'email',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — URL-encoded email address
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;deleteByExternalId($request) -> ?DeleteByExternalIdSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a subscriber by their customer-owned external ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->deleteByExternalId(
    new DeleteByExternalIdSubscribersRequest([
        'externalId' => 'externalId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — External ID. Query form supports IDs containing slashes.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;deleteByExternalIdPath($externalId) -> ?DeleteByExternalIdPathSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Compatibility route for external IDs that do not contain path separators. Use `/subscribers/external?externalId=...` for IDs containing slashes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->deleteByExternalIdPath(
    'externalId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — URL-encoded external ID without path separators
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;deleteNote($noteId) -> ?DeleteNoteSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes one internal subscriber note by note ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->deleteNote(
    'noteId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$noteId:** `string` — Subscriber note ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;get($email, $request) -> ?GetSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieves a subscriber by their email address, including notes, list memberships, sequence enrollments, email stats, and recent activity.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->get(
    'email',
    new GetSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — URL-encoded email address
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events in subscriber email stats and recent activity.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;getAccountInfo() -> ?GetAccountInfoResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns account information for the authenticated API key. Useful for connection labels in integrations.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->getAccountInfo();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;getByExternalId($request) -> ?GetByExternalIdSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieves a subscriber by their customer-owned external ID, including notes, list memberships, sequence enrollments, email stats, and recent activity.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->getByExternalId(
    new GetByExternalIdSubscribersRequest([
        'externalId' => 'externalId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — External ID. Query form supports IDs containing slashes.
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events in subscriber email stats and recent activity.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;getByExternalIdPath($externalId, $request) -> ?GetByExternalIdPathSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Compatibility route for external IDs that do not contain path separators. Use `/subscribers/external?externalId=...` for IDs containing slashes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->getByExternalIdPath(
    'externalId',
    new GetByExternalIdPathSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — URL-encoded external ID without path separators
    
</dd>
</dl>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected scanner, preview, and tracked asset open/click events in subscriber email stats and recent activity.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;getImport($importId) -> ?GetImportSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns progress, counts, and failure summaries by import ID or batch ID. Every excluded row is explained - skippedReasons sums to skippedCount and failedReasons sums to failedCount. Status completed means row processing has finished; custom-attribute sync can still be pending, so attribute-based segment counts may take roughly 30–35 seconds or longer to reflect the updates.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->getImport(
    'importId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$importId:** `string` — Import ID or batch ID returned by the create endpoint.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;getOperation($id) -> ?SubscriberOperationResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires subscribers:read. Tagging and cancelling a tagging task also require subscribers:tag; creating tag definitions requires tags:write; triggering automations requires automations:trigger. Personal keys retain current company role restrictions. Company keys retain company-scoped authority. Workers recheck authority on every page.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->getOperation(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;importEvents($request) -> ?ImportEventsSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Records a bounded batch of up to 25 events for many subscribers. Email is required to create a contact; externalId-only rows must resolve to an existing contact. Events are grouped per contact - a contact whose rows are all more than an hour old is imported silently as history, including no double-opt-in email, while any recent row makes that contact's whole group live. Stable eventIds keep one receipt and let retries re-attempt downstream recovery idempotently.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->importEvents(
    new ImportEventsSubscribersRequest([
        'events' => [
            new ImportEventsSubscribersRequestEventsItem([
                'eventId' => 'order_12345',
                'name' => 'purchase_completed',
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$events:** `array` — Events to record. Each event identifies its own subscriber.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;list($request) -> ?ListSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists subscribers with stable pagination and optional filtering by status, free-text query, tags, list, segment, attribute, or email. Non-attribute results are ordered by createdAt descending with subscriber ID as a deterministic tie-breaker. Attribute-filtered results use ClickHouse-first cursor pagination ordered by subscriber ID ascending and do not include a total count.

**Pulling a full audience:** every response includes `pagination.nextCursor` and `pagination.hasMore`. Follow `nextCursor` rather than incrementing `page`. Cursor pagination keeps results stable while subscribers are being created or deleted mid-pull (page numbers can skip or repeat rows as the underlying set shifts) and skips the total-count query, so `pagination.total` and `pagination.totalPages` are `null` on cursor requests. Combined with `limit=1000`, a 10,000-subscriber export takes ten requests instead of a hundred.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->list(
    new ListSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$attribute:** `?string` — Custom attribute filter using attributeName:value syntax, such as plan:pro or mrr:50.
    
</dd>
</dl>

<dl>
<dd>

**$attributeOperator:** `?string` — Attribute filter operator for direct cursor pagination. Use saved segments for exclusion operators such as is_not, not_contains, or is_empty.
    
</dd>
</dl>

<dl>
<dd>

**$cursor:** `?string` — Opaque cursor returned as pagination.nextCursor. Cannot be combined with `page`. Attribute-filtered requests return their own cursor, which is not interchangeable with the default-ordering cursor.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Legacy alias for a partial email search
    
</dd>
</dl>

<dl>
<dd>

**$includeTotal:** `?string` — Pass `false` to skip the total-count query on page-numbered requests. Cursor requests always skip it.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Number of items per page (max 1000)
    
</dd>
</dl>

<dl>
<dd>

**$list_:** `?string` — Subscriber list ID or exact list name. The API tries ID first, then exact name.
    
</dd>
</dl>

<dl>
<dd>

**$listId:** `?string` — Filter by subscriber list ID.
    
</dd>
</dl>

<dl>
<dd>

**$listName:** `?string` — Filter by exact subscriber list name when the list ID is not known.
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — Page number. Cannot be combined with `cursor`.
    
</dd>
</dl>

<dl>
<dd>

**$query:** `?string` — Free-text search across email, first name, last name, and tags
    
</dd>
</dl>

<dl>
<dd>

**$segmentId:** `?string` — Filter by an existing segment ID
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Filter by subscriber status. Use all to disable status filtering.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?string` — Comma-separated tag names. Subscribers must have all provided tags.
    
</dd>
</dl>

<dl>
<dd>

**$unsubscribedAfter:** `?string` — Only return contacts whose `unsubscribedAt` is on or after this ISO 8601 date or datetime. Bare dates use UTC midnight; datetimes must include `Z` or an explicit offset. Contacts with no recorded opt-out date are excluded.
    
</dd>
</dl>

<dl>
<dd>

**$unsubscribedBefore:** `?string` — Only return contacts whose `unsubscribedAt` is on or before this ISO 8601 date or datetime. Bare dates use UTC midnight; datetimes must include `Z` or an explicit offset. Combine with `unsubscribedAfter` to audit a window of opt-outs.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;listAttributes($request) -> ?ListAttributesSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the custom attribute names in use across the account, so you can reuse existing names and value types when creating or updating subscribers. Value types and examples come from up to 100 recent contacts with custom attributes. Names that only older contacts carry come from the account-wide attribute index, which returns up to the 500 most widely used names, and are included with sampledContacts 0 and the type of their indexed example (a boolean is reported for an example of "true" or "false"). Reserved profile fields (email, first and last name) and internal attributes are not listed. Requires subscribers:read.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->listAttributes(
    new ListAttributesSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$includeNested:** `?string` — Also list nested paths such as profile.tier. Must be true or false. Defaults to false.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;listNotes($email) -> ?ListNotesSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists internal notes for a subscriber identified by email address.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->listNotes(
    'email',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — URL-encoded email address
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;listNotesByExternalId($request) -> ?ListNotesByExternalIdSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists internal notes for a subscriber identified by customer-owned external ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->listNotesByExternalId(
    new ListNotesByExternalIdSubscribersRequest([
        'externalId' => 'externalId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — External ID. Query form supports IDs containing slashes.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;listOperations() -> ?ListOperationsSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns up to twenty recent retained operations for the company. Requires subscribers:read. Tagging and cancelling a tagging task also require subscribers:tag; creating tag definitions requires tags:write; triggering automations requires automations:trigger. Personal keys retain current company role restrictions. Company keys retain company-scoped authority. Workers recheck authority on every page.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->listOperations();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;startOperation($request) -> ?SubscriberOperationResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Requires subscribers:read. Tagging and cancelling a tagging task also require subscribers:tag; creating tag definitions requires tags:write; triggering automations requires automations:trigger. Personal keys retain current company role restrictions. Company keys retain company-scoped authority. Workers recheck authority on every page. Returns immediately with a durable ID. Retry the same requestKey after an uncertain response. Active tasks have a seven-day processing deadline. Completed/failed/cancelled records are retained seven days. Inspect failures before retrying interrupted tagging; an uncertain action is never automatically replayed.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->startOperation(
    new SubscriberOperationStart([
        'kind' => SubscriberOperationStartKind::AddTags->value,
        'requestKey' => 'requestKey',
        'tags' => [
            'tags',
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$audience:** `?SubscriberOperationStartAudience` — Defaults to all contacts. Selection walks live pages before mutations, excludes contacts created after the request, and is not a point-in-time database snapshot. Provide root or filters, never both.
    
</dd>
</dl>

<dl>
<dd>

**$kind:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$requestKey:** `string` — Reuse after an uncertain response. Different normalized settings with the same company/key return 409.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `array` — Tag names, normalized like single-contact tags.
    
</dd>
</dl>

<dl>
<dd>

**$triggerAutomations:** `?bool` — Requires automations:trigger.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;update($emailPathParam, $request) -> ?UpdateSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a subscriber's first name, last name, status, tags, or custom attributes. Setting `status` to `unsubscribed` performs the full unsubscribe workflow, including list unsubscription and sequence cancellation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->update(
    'email',
    new UpdateSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$emailPathParam:** `string` — URL-encoded email address
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Custom attributes to update. Defaults to replacing the existing public custom-attribute map.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributesStrategy:** `?string` — How to apply customAttributes. replace replaces the existing public custom-attribute map. merge overwrites only provided keys and retains unspecified existing keys.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — New delivery email. Fails with 409 if another subscriber owns it.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — New customer-owned external ID. Fails with 409 if another subscriber owns it.
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — Maximum 255 Unicode characters. Excess trailing ASCII spaces are accepted as by PostgreSQL. Longer names return 400 before any changes; correct the name before retrying. Omit to keep unchanged, or send an empty string to clear; null is not accepted.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Maximum 255 Unicode characters. Excess trailing ASCII spaces are accepted as by PostgreSQL. Longer names return 400 before any changes; correct the name before retrying. Omit to keep unchanged, or send an empty string to clear; null is not accepted.
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Phone number in E.164 format or national format. Stored normalized to E.164. Invalid values fail with a 400 validation error. Does not affect SMS consent. Changing it resets SMS consent unless smsConsent is sent in the same request. null or "" clears the phone, except on a phone-only (SMS) contact, where clearing its only identity fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$phoneCountry:** `?string` — ISO 3166-1 alpha-2 country used to read a national-format phone, defaulting to US. A parsing hint only - the stored phoneCountry always comes from the parsed number. Sending it without phone fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$smsConsent:** `?bool` — SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Setting `unsubscribed` performs a full global unsubscribe.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$timezone:** `?string` — IANA timezone identifier such as America/New_York, stored as a native profile field and used for recipient-local campaign delivery. An invalid identifier returns 400 VALIDATION_ERROR. Omit to keep unchanged, or send null to clear.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;updateByExternalId($request) -> ?UpdateByExternalIdSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a subscriber's email, external ID, first name, last name, status, tags, or custom attributes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->updateByExternalId(
    new UpdateByExternalIdSubscribersRequest([
        'externalId' => 'externalId',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalId:** `string` — External ID. Query form supports IDs containing slashes.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Custom attributes to update. Defaults to replacing the existing public custom-attribute map.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributesStrategy:** `?string` — How to apply customAttributes. replace replaces the existing public custom-attribute map. merge overwrites only provided keys and retains unspecified existing keys.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — New delivery email. Fails with 409 if another subscriber owns it.
    
</dd>
</dl>

<dl>
<dd>

**$newExternalId:** `?string` — New external ID. Fails with 409 if another subscriber owns it.
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — Maximum 255 Unicode characters. Excess trailing ASCII spaces are accepted as by PostgreSQL. Longer names return 400 before any changes; correct the name before retrying. Omit to keep unchanged, or send an empty string to clear; null is not accepted.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Maximum 255 Unicode characters. Excess trailing ASCII spaces are accepted as by PostgreSQL. Longer names return 400 before any changes; correct the name before retrying. Omit to keep unchanged, or send an empty string to clear; null is not accepted.
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Phone number in E.164 format or national format. Stored normalized to E.164. Invalid values fail with a 400 validation error. Does not affect SMS consent. Changing it resets SMS consent unless smsConsent is sent in the same request. null or "" clears the phone, except on a phone-only (SMS) contact, where clearing its only identity fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$phoneCountry:** `?string` — ISO 3166-1 alpha-2 country used to read a national-format phone, defaulting to US. A parsing hint only - the stored phoneCountry always comes from the parsed number. Sending it without phone fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$smsConsent:** `?bool` — SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Setting `unsubscribed` performs the unsubscribe workflow.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$timezone:** `?string` — IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Invalid values fail with a 400 validation error; null clears the stored value.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;updateByExternalIdPath($externalIdPathParam, $request) -> ?UpdateByExternalIdPathSubscribersResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Compatibility route for external IDs that do not contain path separators. Use `/subscribers/external?externalId=...` for IDs containing slashes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->updateByExternalIdPath(
    'externalId',
    new UpdateByExternalIdPathSubscribersRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$externalIdPathParam:** `string` — URL-encoded external ID without path separators
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Custom attributes to update. Defaults to replacing the existing public custom-attribute map.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributesStrategy:** `?string` — How to apply customAttributes. replace replaces the existing public custom-attribute map. merge overwrites only provided keys and retains unspecified existing keys.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — New delivery email. Fails with 409 if another subscriber owns it.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — New external ID. Fails with 409 if another subscriber owns it.
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — Maximum 255 Unicode characters. Excess trailing ASCII spaces are accepted as by PostgreSQL. Longer names return 400 before any changes; correct the name before retrying. Omit to keep unchanged, or send an empty string to clear; null is not accepted.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Maximum 255 Unicode characters. Excess trailing ASCII spaces are accepted as by PostgreSQL. Longer names return 400 before any changes; correct the name before retrying. Omit to keep unchanged, or send an empty string to clear; null is not accepted.
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Phone number in E.164 format or national format. Stored normalized to E.164. Invalid values fail with a 400 validation error. Does not affect SMS consent. Changing it resets SMS consent unless smsConsent is sent in the same request. null or "" clears the phone, except on a phone-only (SMS) contact, where clearing its only identity fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$phoneCountry:** `?string` — ISO 3166-1 alpha-2 country used to read a national-format phone, defaulting to US. A parsing hint only - the stored phoneCountry always comes from the parsed number. Sending it without phone fails with a 400 validation error.
    
</dd>
</dl>

<dl>
<dd>

**$smsConsent:** `?bool` — SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Setting `unsubscribed` performs the unsubscribe workflow.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$timezone:** `?string` — IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Invalid values fail with a 400 validation error; null clears the stored value.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Subscribers Events
<details><summary><code>$client-&gt;subscribers-&gt;events-&gt;trigger($request) -> ?TriggerEventsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Triggers an event for a subscriber. Creates the subscriber if they don't exist and applies the workspace default lists setting. Creates the event definition if it doesn't exist. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, the confirmation email is queued, and matching sequences wait at their trigger until the subscriber confirms.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->events->trigger(
    new TriggerEventsRequest([
        'event' => 'purchase.completed',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$account:** `string|TriggerEventsRequestAccountAttributes|null` — Attach the contact to an account (your customer's organization, unrelated to your Sequenzy account). Pass the account's externalId as a string, or an object with externalId plus optional name, domain, role (owner, admin, member) and attributes. The account is created when missing and its context is added to the event as `event.account.*`. Only used once the workspace has Accounts on (it has at least one account, or Accounts was turned on in the dashboard). Before that, the field is ignored in any shape and the response includes `accountIgnored`.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Optional attributes to set on the subscriber if created
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$event:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$eventId:** `?string` — Caller-owned event ID used as an idempotency key on both paths. A repeated live event returns the existing event with duplicate=true. A repeated historical event remains a historical response and increments duplicates instead. Best-effort for live events sent within about a second of each other, so a producer needing a strict guarantee should keep its own ledger.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Customer-owned app/customer/user ID
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — First name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Last name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$occurredAt:** `?DateTime` — When the event actually happened. Defaults to now. More than an hour in the past records it as history - stored with the real timestamp and counted by segments, but running no sequences, sync rules, waiting steps, goal conversions or webhooks, and the response carries historical=true. Older than the 5-year event retention window is rejected with 400.
    
</dd>
</dl>

<dl>
<dd>

**$properties:** `?array` — Event properties/metadata
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;events-&gt;triggerBulk($request) -> ?TriggerBulkEventsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Triggers multiple events for a subscriber. Creates the subscriber if they don't exist and applies the workspace default lists setting. Creates event definitions if they don't exist. Events are processed independently, so an error response may still include events that were already triggered. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, a single confirmation email is queued for the request, and matching sequences wait at their trigger until the subscriber confirms.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->events->triggerBulk(
    new TriggerBulkEventsRequest([
        'events' => [
            new TriggerBulkEventsRequestEventsItem([
                'name' => 'page.viewed',
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$customAttributes:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$events:** `array` 
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Customer-owned app/customer/user ID
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — First name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Last name to set if creating the subscriber.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Subscribers Tags
<details><summary><code>$client-&gt;subscribers-&gt;tags-&gt;add($request) -> ?AddTagsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds a tag to a subscriber. Creates the subscriber if they don't exist. Creates the tag definition if it doesn't exist. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, the confirmation email is queued, and tag automations wait at their trigger until the subscriber confirms.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->tags->add(
    new AddTagsRequest([
        'tag' => 'premium',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$customAttributes:** `?array` — Optional attributes to set on the subscriber if created
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Customer-owned app/customer/user ID
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — First name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Last name to set if creating the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$tag:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;subscribers-&gt;tags-&gt;remove($request) -> ?RemoveTagsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes a tag from a subscriber. Creates the subscriber if they don't exist (without the tag).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->subscribers->tags->remove(
    new RemoveTagsRequest([
        'tag' => 'premium',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `?string` — Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$externalId:** `?string` — Customer-owned app/customer/user ID
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` — First name (used if creating new subscriber)
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` — Last name (used if creating new subscriber)
    
</dd>
</dl>

<dl>
<dd>

**$tag:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Suppressions
<details><summary><code>$client-&gt;suppressions-&gt;get($email, $request) -> ?GetSuppressionsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Checks one exact recipient against Sequenzy's bounce and complaint safeguards. Sequenzy suppresses solely from its own bounce records; the email provider's account-level suppression list is not consulted. The lookup does not expose unrelated recipients.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->suppressions->get(
    'email',
    new GetSuppressionsRequest([
        'region' => 'us-east-1',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — Exact recipient email address
    
</dd>
</dl>

<dl>
<dd>

**$region:** `?string` — Deprecated: accepted and ignored. It previously limited a provider-side suppression lookup, which no longer happens.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;suppressions-&gt;list($request) -> ?ListSuppressionsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the recipients this company cannot reach, newest suppression first by default.

Four product-level suppression types appear:

- `suppressionType: invalid_recipient` - SMTP evidence conclusively identifies an invalid destination. It is global, visible to companies associated with the address, and protected.
- `suppressionType: unknown_hard_bounce` - a permanent/undetermined failure without enough evidence to declare the inbox invalid. It is company-scoped and protected.
- `suppressionType: soft_bounce_escalation` - repeated delivery failures from this company. It is company-scoped and removable.
- `suppressionType: complaint` - the recipient reported this company's email as spam. It is company-scoped and protected.

The platform-wide list is never exposed: a global row is returned only when the address is already associated with the authenticated company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->suppressions->list(
    new ListSuppressionsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$limit:** `?int` — Entries per page (max 100).
    
</dd>
</dl>

<dl>
<dd>

**$order:** `?string` — Sort direction. Defaults to `desc` for `suppressedAt` and `status`, `asc` for `email`.
    
</dd>
</dl>

<dl>
<dd>

**$page:** `?int` — 1-based page number.
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` — Case-insensitive substring filter on the recipient email address.
    
</dd>
</dl>

<dl>
<dd>

**$sort:** `?string` 

Field to order by. `status` lists removable workspace escalations before protected
suppressions. An unrecognized value falls back to `suppressedAt` rather than failing the
request - read `sortBy` in the response to confirm what was applied.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;suppressions-&gt;remove($email, $request) -> ?RemoveSuppressionsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes one company-associated recipient's workspace-scoped soft-bounce escalation and reactivates a bounced company subscriber. Global invalid-recipient suppressions, other companies' scoped rows, complaints, and unsubscribes are protected.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->suppressions->remove(
    'email',
    new RemoveSuppressionsRequest([
        'region' => 'us-east-1',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — Exact company-associated recipient email address
    
</dd>
</dl>

<dl>
<dd>

**$region:** `?string` — Deprecated: accepted and ignored. It previously limited a provider-side suppression lookup, which no longer happens.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## SyncRules
<details><summary><code>$client-&gt;syncRules-&gt;get() -> ?GetSyncRulesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with an empty rule set; legacy companies may inherit the optional SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->syncRules->get();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;syncRules-&gt;update($request) -> ?UpdateSyncRulesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replaces the company's full sync rule set. Send an empty array to disable rules, or null to opt into the inherited SaaS/ecommerce platform preset. This is not a partial update - fetch the current rules, edit them, and send the whole set back.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->syncRules->update(
    new UpdateSyncRulesRequest([
        'syncRules' => [
            new SyncRule([
                'actions' => new SyncRuleActions([
                    'addTags' => [
                        'vinyl-collector',
                    ],
                    'removeTags' => [
                        'removeTags',
                    ],
                ]),
                'conditions' => new SyncRuleConditions([
                    'purchasedProduct' => new SyncRuleConditionsPurchasedProduct([
                        'tags' => [
                            'Vinyl',
                        ],
                    ]),
                ]),
                'triggerEvent' => 'ecommerce.order_placed',
            ]),
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$syncRules:** `?array` — Full replacement rule set. An empty array disables rules; null opts into the inherited SaaS/ecommerce platform preset.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Tags
<details><summary><code>$client-&gt;tags-&gt;create($request) -> ?CreateTagsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a tag definition. Tag names are normalized to lowercase with spaces replaced by hyphens.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->tags->create(
    new CreateTagsRequest([
        'name' => 'premium',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$color:** `?string` — Tag color. One of: gray, red, orange, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose. Defaults to gray.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` — Tag name. Normalized to lowercase with spaces replaced by hyphens.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;tags-&gt;delete($tagId) -> ?DeleteTagsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a tag definition and removes the tag from all subscribers. Fails when the tag is referenced by sequences or is a system tag.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->tags->delete(
    'tagId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$tagId:** `string` — Tag definition ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;tags-&gt;list() -> ?ListTagsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists tag definitions for the authenticated company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->tags->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;tags-&gt;update($tagId, $request) -> ?UpdateTagsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a tag definition's color. System tags cannot be updated.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->tags->update(
    'tagId',
    new UpdateTagsRequest([
        'color' => 'green',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$tagId:** `string` — Tag definition ID.
    
</dd>
</dl>

<dl>
<dd>

**$color:** `string` — Tag color. One of: gray, red, orange, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Team
<details><summary><code>$client-&gt;team-&gt;cancelInvitation($invitationId) -> ?CancelInvitationTeamResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Cancels a pending or expired team invitation. Requires owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->team->cancelInvitation(
    'invitationId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$invitationId:** `string` — Invitation ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;team-&gt;invite($request) -> ?InviteTeamResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds an existing Sequenzy user to the team directly, or emails an invitation to a new user. Requires owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->team->invite(
    new InviteTeamRequest([
        'email' => 'email',
        'role' => InviteTeamRequestRole::Admin->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$canManageBilling:** `?bool` — Whether the member can manage billing. Only the company owner can grant this.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `string` — Email address to invite.
    
</dd>
</dl>

<dl>
<dd>

**$role:** `string` — Role for the new member. Marketers create, edit, and send campaigns and sequences and manage subscribers but cannot access transactional emails, settings, billing, or the team. Restricted members can open direct campaign links only.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;team-&gt;list() -> ?ListTeamResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the company owner, team members, and pending or expired invitations.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->team->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Templates
<details><summary><code>$client-&gt;templates-&gt;check($templateId, $request) -> ?CheckEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Run the pre-send email check on a saved template: the same rules as the editor's email checker, plus live verification of every link and image, including links in every A/B variant and translation unless variantId or locale pins one version. Read-only: this never sends or modifies anything, and uses POST only so personalization input can travel in a request body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->check(
    'templateId',
    new CheckTemplatesRequest([
        'body' => new CheckEmailRequest([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, or a transactional email ID or slug
    
</dd>
</dl>

<dl>
<dd>

**$request:** `CheckEmailRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;create($request) -> ?CreateTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a reusable email template from exactly one of prompt, HTML, or Sequenzy blocks. Creating a standalone copy of a saved email or gallery design and AI rewriting within its layout are currently dashboard-only workflows. This endpoint has no source-template copy operation; prompt generates new content without preserving an existing layout. See /concepts/email-templates#availability-across-interfaces for the documented interface exception and supported alternatives.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->create(
    new CreateTemplatesRequest([
        'name' => 'name',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$blocks:** `?array` — Sequenzy email blocks. Mutually exclusive with html. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.
    
</dd>
</dl>

<dl>
<dd>

**$html:** `?string` — Raw HTML body. Mutually exclusive with blocks.
    
</dd>
</dl>

<dl>
<dd>

**$isTemplate:** `?bool` — Save as a reusable master design that sequence steps and campaigns can start from (always as an independent copy).
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?array` — Compatibility alias for labels.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Label names to assign. Missing labels are created automatically.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$prompt:** `?string` — Natural-language request for branded native template blocks.
    
</dd>
</dl>

<dl>
<dd>

**$style:** `?string` — Generation style; valid only with prompt. Pass designed or plain to force the designed or plain-text email style; other values are freeform prompt guidance. Defaults to the company's email style preference.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Required with HTML or blocks; optional with prompt, where it overrides the generated subject.
    
</dd>
</dl>

<dl>
<dd>

**$tone:** `?string` — Generation tone; valid only with prompt.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;createFromExample($request) -> ?CreateFromExampleTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remixes a public email from the Sequenzy email gallery into a new email template for your company. The new email keeps the example's exact layout and design; AI rewrites every piece of text for your company and your logo, brand color and website links are swapped in. It is saved as an HTML template. The example brand is never named, and none of its copy, offers or claims are reused. Its legal footer is removed; your own compliant footer is added when you send. Generation usually takes 5 to 20 seconds. Nothing is saved when generation fails; every successful call creates another template. Requires `templates:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->createFromExample(
    new CreateFromExampleTemplatesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$brand:** `?string` — Gallery brand slug. Use with `email` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$brief:** `?string` — Optional direction for the new email. Takes priority over the example.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Gallery email slug. Use with `brand` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Template name. Defaults to the generated subject followed by "(remix of {brand})".
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Gallery email page URL, such as `https://sequenzy.com/email-examples/brands/linear/emails/welcome-to-linear`.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;createShareLink($templateId) -> ?CreateShareLinkTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates (or fetches) the public view-in-browser link for an individual email - a transactional email, a sequence email, or a standalone template. Accepts a template ID or a transactional email's ID or slug; for a sequence email, pass the step's emailId. The hosted page renders an anonymized copy - sample contact, inert unsubscribe link, no open/click tracking - so the URL is safe to forward to anyone. Idempotent - an already-active link is returned with created=false instead of being rotated. Campaigns use their own campaign-level share link, which follows the A/B winning variant.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->createShareLink(
    'templateId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;delete($templateId) -> ?DeleteTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes an unused email template. Templates used by campaigns, sequences, or transactional emails cannot be deleted.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->delete(
    'templateId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;get($templateId) -> ?GetTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one email template. Transactional email IDs and slugs are also resolved for compatibility, as is the `emailId` returned by campaign endpoints, so this can read the blocks of an email designed in the dashboard.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->get(
    'templateId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;list($request) -> ?ListTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists saved email templates for the authenticated company, optionally filtered by label. Templates are the company's saved email bodies: standalone templates plus the bodies behind campaigns and transactional emails, so dashboard-designed emails appear here too. A campaign's `emailId` points at its entry in this list, and any template ID can be passed as `templateId` when creating a campaign. Bodies are kept when their campaign or transactional email is deleted. Content snapshots of code-managed transactional emails (created by sends with `trackAs`) are not listed and cannot be used as `templateId`. Results are newest first and paginated: 50 per page by default, up to 100. Page with `offset` while `pagination.hasMore` is true.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->list(
    new ListTemplatesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$isTemplate:** `?bool` — Filter to reusable master designs (`true`) or everything else (`false`). Omit to list every body.
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?string` — Optional label name filter. Only templates assigned this label are returned.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` — Templates per page. Values above 100 are clamped to 100.
    
</dd>
</dl>

<dl>
<dd>

**$offset:** `?int` — Templates to skip before returning results.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;previewFromExample($request) -> ?PreviewFromExampleTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Rewrites a public email from the Sequenzy email gallery for your brand, or for another `website`, and returns it without saving anything. Same rewrite as Create Template from Example. Usually takes 5 to 20 seconds. Requires `templates:write`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->previewFromExample(
    new PreviewFromExampleTemplatesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$brand:** `?string` — Gallery brand slug. Use with `email` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$brief:** `?string` — Optional direction for the email. Takes priority over the example.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `?string` — Gallery email slug. Use with `brand` instead of `url`.
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` — Gallery email page URL, or a sequence page URL ending in `#email-{email}`.
    
</dd>
</dl>

<dl>
<dd>

**$website:** `?string` — Optional site or domain, such as `acme.com`, to write the preview for instead of your own brand. Its registrable domain is looked up like the public gallery preview. Omit it to use your company's brand profile.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;render($templateId, $request) -> ?RenderEmailResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Render a template to the exact email-safe HTML that would be sent, for embedding a visual preview. Read-only: this never sends or modifies anything, and uses POST only so personalization input can travel in a request body.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->render(
    'templateId',
    new RenderTemplatesRequest([
        'body' => new RenderEmailRequest([]),
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>

<dl>
<dd>

**$request:** `RenderEmailRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;revokeShareLink($templateId) -> ?RevokeShareLinkTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Revokes the email's public view-in-browser link. The shared URL returns 404 immediately; sharing again later mints a different URL. Returns revoked=false when no link was active.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->revokeShareLink(
    'templateId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;setLocalization($templateId, $locale, $request) -> ?SetLocalizationTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates or replaces a caller-supplied localized template variant. The locale must be enabled for the company and cannot be its primary locale.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->setLocalization(
    'templateId',
    'locale',
    new SetLocalizationTemplatesRequest([
        'subject' => 'subject',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>

<dl>
<dd>

**$locale:** `string` — Enabled non-primary locale code such as es or pt-BR.
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` — Localized Sequenzy email blocks. Provide exactly one of blocks or html.
    
</dd>
</dl>

<dl>
<dd>

**$html:** `?string` — Localized raw HTML. Provide exactly one of html or blocks.
    
</dd>
</dl>

<dl>
<dd>

**$keepEdits:** `?bool` — Protect this translation like a dashboard edit. It is marked as edited (editedAt), automatic translation on save keeps it, and it becomes stale instead of being replaced when the original changes. Without it, the stored content is retranslated on the next save when automatic translation is on, and any earlier edit flag is cleared.
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` — Optional localized inbox preview text.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `string` — Localized email subject line.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;syncLocalizations($templateId, $request) -> ?SyncLocalizationsTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues AI translation for selected enabled template locales. Omit locales to sync every enabled non-primary locale, even when automatic on-save sync is disabled.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->syncLocalizations(
    'templateId',
    new SyncLocalizationsTemplatesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>

<dl>
<dd>

**$locales:** `?array` — Enabled non-primary locale codes to sync. Omit to sync all of them.
    
</dd>
</dl>

<dl>
<dd>

**$skipEdited:** `?bool` — Keep translations someone edited instead of retranslating them. Kept locales are returned in skippedLocales.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;templates-&gt;update($templateId, $request) -> ?UpdateTemplatesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates template metadata, labels, or content. Transactional email IDs and slugs are also resolved for compatibility.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->templates->update(
    'templateId',
    new UpdateTemplatesRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$templateId:** `string` — Template ID, transactional email ID, or transactional slug.
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` — Replacement Sequenzy email blocks. Mutually exclusive with html. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.
    
</dd>
</dl>

<dl>
<dd>

**$html:** `?string` — Replacement HTML body. Mutually exclusive with blocks.
    
</dd>
</dl>

<dl>
<dd>

**$isTemplate:** `?bool` — Mark (true) or unmark (false) this email as a reusable master design.
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?array` — Compatibility alias for labels.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Replacement label names. Send an empty array to clear labels. Missing labels are created automatically.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` — Inbox preview text. Send null to clear it.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$updates:** `mixed` — Unsupported nested update object. Requests using it return a validation error.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## TrackingDomain
<details><summary><code>$client-&gt;trackingDomain-&gt;getTrackingDomain() -> ?GetTrackingDomainResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns the company tracking domain every sending domain uses for tracked links and opens, or null when links use the shared Sequenzy tracking domain. Requires the account:read scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->trackingDomain->getTrackingDomain();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;trackingDomain-&gt;removeTrackingDomain() -> ?RemoveTrackingDomainResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes the company tracking domain. New emails use the shared Sequenzy tracking domain, and links in emails already sent through the removed domain stop working. Removing when none is set succeeds with removed false. Requires the companies:manage scope plus owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->trackingDomain->removeTrackingDomain();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;trackingDomain-&gt;setTrackingDomain($request) -> ?SetTrackingDomainResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Sets or changes the company tracking domain. Any subdomain the caller controls works, including one on a root other than the sending domains; a bare registrable domain is rejected because it cannot hold a CNAME. Publish the returned cnameRecord. Sending never waits for it; new emails use the shared Sequenzy tracking domain until it verifies. Saving the current hostname again only rechecks it. Changing the hostname keeps the previous one serving links in emails already sent while its old CNAME stays. Requires the companies:manage scope plus owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->trackingDomain->setTrackingDomain(
    new SetTrackingDomainRequest([
        'domain' => 'domain',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `string` — Tracking hostname, a subdomain such as links.example.com. A leading https:// and trailing path are ignored.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;trackingDomain-&gt;verifyTrackingDomain() -> ?VerifyTrackingDomainResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Checks the company tracking domain's CNAME and HTTPS certificate now instead of waiting for the automatic checks. Requires the companies:manage scope plus owner or admin access.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->trackingDomain->verifyTrackingDomain();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## TrackingSettings
<details><summary><code>$client-&gt;trackingSettings-&gt;get() -> ?TrackingSettings</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns account-wide and Transactional API open/click tracking flags, unsubscribe tracking, attribution, UTM tagging, tracking domain, inbound reply settings and signup consent settings.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->trackingSettings->get();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;trackingSettings-&gt;update($request) -> ?UpdateTrackingSettingsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates the account-wide and Transactional API tracking defaults - open, click, and unsubscribe tracking, strict bot filtering, the default attribution window, and automatic UTM tagging - plus the double opt-in requirement for new contacts. Applies to emails sent afterwards; already-sent emails keep the links they were rendered with. Reply tracking is updated through the company endpoint.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->trackingSettings->update(
    new UpdateTrackingSettingsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$autoUtmEnabled:** `?bool` — Whether UTM parameters are appended to outbound links automatically. Enabling this with no stored parameters seeds the platform defaults.
    
</dd>
</dl>

<dl>
<dd>

**$autoUtmSettings:** `?UpdateTrackingSettingsRequestAutoUtmSettings` — UTM templates merged over the stored ones. Null resets every parameter to the platform defaults; a null field stops that parameter being emitted.
    
</dd>
</dl>

<dl>
<dd>

**$clickTrackingEnabled:** `?bool` — Whether to rewrite links through the click-tracking redirect.
    
</dd>
</dl>

<dl>
<dd>

**$defaultAttributionWindowHours:** `?int` — Default revenue attribution window in hours.
    
</dd>
</dl>

<dl>
<dd>

**$doubleOptInEnabled:** `?bool` — Whether new contacts must confirm by email before they become subscribed. This is the account-wide default that the per-request optInMode on subscriber creation overrides. Enabling it requires a sender profile and provisions the confirmation email automatically; it does not change contacts that are already active.
    
</dd>
</dl>

<dl>
<dd>

**$doubleOptInRedirectUrl:** `?string` — Where the hosted confirmation page sends subscribers after they confirm. Must be an http(s) URL of at most 500 characters after normalization; a bare domain is normalized to https. Null (or an empty string) clears it, keeping subscribers on the confirmation page branded with the company's name, logo, and colors.
    
</dd>
</dl>

<dl>
<dd>

**$openTrackingEnabled:** `?bool` — Whether to embed the open-tracking pixel.
    
</dd>
</dl>

<dl>
<dd>

**$strictBotFilteringEnabled:** `?bool` — Opt-in aggressive bot detection (strict user-agent patterns, datacenter and Microsoft Azure IPs, fast campaign and sequence clicks from IPs clicking other recipients' emails, cross-send IP sweeps). Off by default; enabling it can lower reported open and click rates.
    
</dd>
</dl>

<dl>
<dd>

**$transactionalClickTrackingEnabled:** `?bool` — Click tracking default for sends through the Send Email API. Account-wide click tracking must also be enabled; per-send trackingSettings can only opt out.
    
</dd>
</dl>

<dl>
<dd>

**$transactionalOpenTrackingEnabled:** `?bool` — Open tracking default for sends through the Send Email API. Account-wide open tracking must also be enabled; per-send trackingSettings can only opt out.
    
</dd>
</dl>

<dl>
<dd>

**$unsubscribeTrackingEnabled:** `?bool` — Whether to track unsubscribe link clicks. When false, Sequenzy unsubscribe links go directly to https://sequenzy.com, even with a custom tracking domain. Actual unsubscribes and their email attribution are still recorded.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Transactional
<details><summary><code>$client-&gt;transactional-&gt;create($request) -> ?CreateTransactionalResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a saved transactional email template from exactly one of prompt, HTML, or Sequenzy blocks. Prompt-created templates default to disabled.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->transactional->create(
    new CreateTransactionalRequest([
        'name' => 'Password Reset',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$enabled:** `?bool` — Defaults to false with prompt and true with explicit HTML or blocks.
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Company label names. Trimmed and deduplicated; missing names are created. Replaces all assignments; [] clears them. Omit to preserve assignments on update or start without labels on create. Null and blank names are rejected.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$prompt:** `?string` — Natural-language request for branded transactional blocks.
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` — Optional API slug used when sending by slug. If omitted, one is generated from the name.
    
</dd>
</dl>

<dl>
<dd>

**$style:** `?string` — Generation style; valid only with prompt. Pass designed or plain to force the designed or plain-text email style; other values are freeform prompt guidance. Defaults to the company's email style preference.
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Required with HTML or blocks; optional with prompt, where it overrides the generated subject.
    
</dd>
</dl>

<dl>
<dd>

**$tone:** `?string` — Generation tone; valid only with prompt.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;transactional-&gt;delete($idOrSlug) -> ?DeleteTransactionalResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently deletes a saved transactional email template by ID or slug, so its slug stops sending and becomes free to reuse.

Already-sent deliveries are untouched: send history, stats, and stored HTML live on the deliveries themselves.

The email content is kept as a reusable template and returned as `deleted.emailId`; pass that to `DELETE /api/v1/templates/{templateId}` to remove the content too. Code-managed emails (`managedBy: code`) are the exception: their content snapshot is deleted with them, so the returned `emailId` no longer exists. To stop sends without losing the template, update it with `enabled: false` instead.

Requires an API key with the `transactional:delete` scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->transactional->delete(
    'welcome-email',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$idOrSlug:** `string` — Transactional email ID or slug
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;transactional-&gt;get($idOrSlug) -> ?GetTransactionalResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Gets details of a transactional email template by ID or slug, including linked body content and available template variables.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->transactional->get(
    'welcome-email',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$idOrSlug:** `string` — Transactional email ID or slug
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;transactional-&gt;list($request) -> ?ListTransactionalResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists transactional email templates with their linked subjects and all-time delivery metrics. Search name, slug, or subject; filter active state; and sort by engagement. Human engagement is used by default.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->transactional->list(
    new ListTransactionalRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$includeMachineEngagement:** `?bool` — Include detected bot, scanner, preview, and privacy-proxy engagement in open and click metrics.
    
</dd>
</dl>

<dl>
<dd>

**$label:** `?string` — Filter by company label names, matching any. Repeat the parameter for multiple names; commas are literal characters. Combined with search and status. Unknown names match no templates.
    
</dd>
</dl>

<dl>
<dd>

**$order:** `?string` — Sort direction.
    
</dd>
</dl>

<dl>
<dd>

**$search:** `?string` — Case-insensitive search across template name, API slug, and linked email subject/title.
    
</dd>
</dl>

<dl>
<dd>

**$sort:** `?string` — Sort by creation date or all-time engagement metrics.
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` — Filter by template active state.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;transactional-&gt;send($request) -> SendTransactionalResponseZero|SendTransactionalResponseOne|null</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues an email for sending. The default `emailType` is `transactional`. Set it to `marketing` for a consented single-recipient lifecycle or promotional message. Marketing mode creates or links a minimal subscriber, honors unsubscribe suppression, adds the standard marketing footer, and emits RFC 8058 one-click-unsubscribe headers. The caller remains responsible for having consent or another lawful basis.

For callers that may retry, send a stable `Idempotency-Key` header. The same key and request returns the original `emailSendId` for 14 days without another delivery. Reusing a key with different request content returns 409.

Repeated identical transactional content reaching many distinct recipients can trigger a junk/list-testing review. Sending continues while review is pending or unavailable. A substantiated verdict can reject later matching deliveries before sending; these become terminal `failed` sends with an `errorMessage` beginning `Transactional content rejected:`. Read GET /email-sends/{emailSendId} for the final outcome. Failed deliveries are not held or replayed automatically, and replaying the same Idempotency-Key returns the original acceptance response. Dashboard retries of rejected deliveries also fail without sending, even after the decision expires. Correct the content or contact support before deliberately submitting a new logical send. This check does not pause the company or ban the account.

You can either:
- Provide a canonical `slug` (or compatibility alias `templateId`) to use a saved template
- Provide `subject` and canonical `body` (or compatibility alias `html`) to send custom content directly

If both a canonical field and its alias are provided, `slug` must match `templateId` and `body` must match `html`.

**Tracking direct-content sends:**
- Set `trackAs` on a direct-content send (for example `weekly-report`) to count it under one code-managed transactional email. The first send with a new value creates it with `managedBy: code`; later sends with the same value link to it. The value may use up to 255 ASCII letters, digits, spaces and `. _ - : /`, and is normalized like a slug (`Weekly Report` and `weekly-report` are the same email). Other values, including empty ones, return 400 `INVALID_TRACK_AS`.
- Opens, clicks, bounces and the other transactional stats then aggregate on that email, and it appears in `GET /transactional` next to your saved templates. Its subject, preview text and HTML are a snapshot of a recent send, refreshed at most every 10 minutes and stored before variable substitution.
- Disabling the code-managed email makes further sends with that `trackAs` fail with 400 `TRACKED_EMAIL_DISABLED` until you enable it again. Deleting it lets the next send recreate it with fresh stats.
- `trackAs` cannot be combined with `slug`/`templateId`, cannot reuse the slug of a template managed in the dashboard, and a company can have at most 100 code-managed emails. Use a stable name for an email type, never per-recipient values. Code-managed emails cannot be sent by `slug`.
- The email is created after the send passes request validation, so an invalid send does not create it. A send that fails later, for example on an `Idempotency-Key` conflict, can still leave the newly created email with no sends.

**Recipients:**
- `to` can be a single email or an array of up to 50 emails
- Duplicate emails are automatically deduplicated
- Marketing mode requires exactly one `to` recipient and does not support `cc` or `bcc`

**Attachments:**
- Attachments can be provided as Base64-encoded content or URLs
- Maximum 10 attachments and 15MB total per email
- Any file type supported (PDFs, images, documents, etc.)
- Set `contentId` on an attachment to embed it as an inline image referenced from the HTML as `<img src="cid:VALUE">`

A successful response means the email was accepted for background processing. Transactional emails are not blocked by subscriber unsubscribe or double opt-in status. If a recipient is suppressed because of a hard bounce or spam complaint, the worker records the send as `suppressed` instead of delivering it.

Optionally set `from` (domain must be verified) and `replyTo` addresses. When reply tracking is enabled, Sequenzy uses a unique trackable `Reply-To` header and treats the resolved reply destination as the forwarding destination for captured replies.
Without a reply identity override, saved-template sends prefer the template reply profile. Otherwise sends prefer the effective sending domain's default reply profile, then the company default, then the first company reply profile. The resolved destination is retained whether or not reply tracking is enabled; it is sent as the Reply-To header only when reply tracking is disabled.
Variables can be passed to customize the email content. Nested objects and arrays are supported for repeat blocks, such as `items`. `{{viewInBrowserUrl}}` is generated automatically for a hosted copy link. For a single recipient, Sequenzy matches an existing subscriber by `subscriberExternalId` or email and backfills stored first and last names when the corresponding request variables are omitted; explicit variables take precedence. Returns immediately with a durable `emailSendId` and the accepted `emailType`. If Sequenzy detects likely missing or unused variables before queueing, the successful response includes a non-blocking `diagnostics` warning object. Missing values do not block queueing or sending; a required variable that is not provided and has no default renders as an empty string.

Select existing identities with senderProfileId or fromEmail (and optional fromName), and replyProfileId or replyTo (with optional replyToName). These inputs look up profiles rather than create them. Use emailType, not isMarketing, to choose delivery policy.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->transactional->send(
    new SendTransactionalRequest([
        'slug' => 'welcome-email',
        'to' => 'recipient@example.com',
        'variables' => [
            'NAME' => "John",
        ],
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$idempotencyKey:** `?string` — Caller-owned key for one logical email. Reuse the same key and request on retries to receive the original send for 14 days. Reusing the key with different content returns 409.
    
</dd>
</dl>

<dl>
<dd>

**$attachments:** `?array` 

File attachments for the email. Each attachment must have a filename and either:
- `content`: Base64-encoded file content
- `path`: URL to fetch the file from

Set `contentId` to embed the file as an inline image the HTML references with `<img src="cid:VALUE">` instead of attaching it.

Maximum 10 attachments and 15MB total per email.
    
</dd>
</dl>

<dl>
<dd>

**$bcc:** `string|array|null` — Blind-carbon-copy recipient email address(es). Duplicates already present in `to` or `cc` are removed.
    
</dd>
</dl>

<dl>
<dd>

**$body:** `?string` — Canonical email body HTML content (required if not using a template slug).
    
</dd>
</dl>

<dl>
<dd>

**$cc:** `string|array|null` — Visible carbon-copy recipient email address(es). Duplicates already present in `to` are removed.
    
</dd>
</dl>

<dl>
<dd>

**$emailType:** `?string` — Delivery policy. Marketing mode requires one recipient, creates or links a minimal subscriber, honors unsubscribe suppression, adds the standard footer, and emits RFC 8058 List-Unsubscribe and List-Unsubscribe-Post headers.
    
</dd>
</dl>

<dl>
<dd>

**$from:** `?string` 

Custom from address. Format: "Name <email>" or just "email".
The domain must be verified for your account. If not verified, this field is silently ignored.
When the address exactly matches an existing sender identity (the display name disambiguates if
several identities share the address), that identity - including its sending route - is used for
the send; otherwise the template or company-default identity is kept and this field only changes
the visible From.
 Mutually exclusive with senderProfileId, fromEmail and fromName.
    
</dd>
</dl>

<dl>
<dd>

**$fromEmail:** `?string` — Address of an existing verified sender profile in this company. Mutually exclusive with senderProfileId and from. If several identities share the address, select one with fromName.
    
</dd>
</dl>

<dl>
<dd>

**$fromName:** `?string` — Display name selecting an existing identity on fromEmail. Requires fromEmail; mutually exclusive with senderProfileId and from. Does not create a profile.
    
</dd>
</dl>

<dl>
<dd>

**$headers:** `?array` — Extra email headers as header name to string value, up to 50 applied. Names use letters, digits and hyphens (max 100 characters); values are one line of printable ASCII and each `Name: value` line fits in 998 characters. A transactional send can carry your own `List-Unsubscribe`, plus `List-Unsubscribe-Post: List-Unsubscribe=One-Click` for RFC 8058 one-click unsubscribe; unsubscribes through your link are not suppressed in Sequenzy. Marketing sends always use Sequenzy's signed unsubscribe headers, so `List-Unsubscribe`, `List-Unsubscribe-Post`, `Precedence` and `Feedback-ID` are not applied. Headers Sequenzy manages (From, Sender, To, Cc, Bcc, Reply-To, Subject, Date, Message-ID, MIME-Version, Return-Path, Received, Received-SPF, Delivered-To, DKIM-Signature, Authentication-Results, and names starting with Content-, X-Sequenzy-, X-SES-, ARC- or Resent-) are never applied. A header that cannot be applied never fails the request; it is listed in the response `ignoredHeaders`. Names match case-insensitively; when names differ only in case, only the first one is considered, even if it is not applied. A retry of a failed delivery (dashboard or outage recovery) resends without these headers.
    
</dd>
</dl>

<dl>
<dd>

**$html:** `?string` — Compatibility alias for `body`. Accepted with `subject` for direct sends and must match `body` when both are provided.
    
</dd>
</dl>

<dl>
<dd>

**$preview:** `?string` — Preview text for the email (only used with direct content)
    
</dd>
</dl>

<dl>
<dd>

**$replyProfileId:** `?string` — Existing reply profile ID. Mutually exclusive with replyTo and replyToName. Overrides the saved template and default reply identity.
    
</dd>
</dl>

<dl>
<dd>

**$replyTo:** `?string` — Reply-to address as "Name <email>" or a bare email, optionally paired with replyToName. Mutually exclusive with replyProfileId. With reply tracking enabled, Sequenzy sends a trackable Reply-To and stores this address as its forwarding destination. Without a reply override, saved-template sends prefer the template reply profile; otherwise sends prefer the effective sending-domain default, then company default, then the first company reply profile.
    
</dd>
</dl>

<dl>
<dd>

**$replyToName:** `?string` — Display name for a bare replyTo address. Requires replyTo and is mutually exclusive with replyProfileId. Does not create a profile.
    
</dd>
</dl>

<dl>
<dd>

**$senderProfileId:** `?string` — Existing verified sender profile ID. Mutually exclusive with fromEmail, fromName and from. Selects that identity and its sending route; does not create a profile.
    
</dd>
</dl>

<dl>
<dd>

**$slug:** `?string` — Canonical slug of the transactional email template to use (mutually exclusive with direct content).
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` — Email subject (required if not using slug)
    
</dd>
</dl>

<dl>
<dd>

**$subscriberExternalId:** `?string` — Customer-owned subscriber ID for single-recipient sends. If it matches an existing subscriber, analytics and localization use that subscriber; the value is also stored on the send and emitted as external_id in outbound email webhooks even when no subscriber exists. Maximum length is 255 characters.
    
</dd>
</dl>

<dl>
<dd>

**$templateId:** `?string` — Compatibility alias for `slug`. Despite the field name, pass the saved transactional email API slug, not its database ID. Must match `slug` when both are provided.
    
</dd>
</dl>

<dl>
<dd>

**$to:** `string|array` — Recipient email address(es). Can be a single email string or an array of up to 50 emails.
    
</dd>
</dl>

<dl>
<dd>

**$trackAs:** `?string` — Direct content only. Names the email type so its sends are counted under one code-managed transactional email, created on first use. Up to 255 ASCII letters, digits, spaces and `. _ - : /`, including at least one letter or digit; it is normalized like a slug. Cannot be combined with `slug`/`templateId`.
    
</dd>
</dl>

<dl>
<dd>

**$trackingSettings:** `?SendTransactionalRequestTrackingSettings` — Per-send tracking opt-outs. Omitted fields follow the company Transactional API open/click defaults. Set false to disable tracking for this send. Neither true nor omission can enable tracking disabled by account-wide or Transactional API settings.
    
</dd>
</dl>

<dl>
<dd>

**$variables:** `?array` — Variables for template replacement (works with both modes). Values can be scalars, nested objects, or arrays used by repeat blocks. For a single recipient, stored subscriber first and last names fill missing name variables; explicit request variables take precedence. Raw HTML templates can use simple subscriber/custom-attribute conditionals such as `{{#if subscriber.plan}}...{{else}}...{{/if}}` and `{{#unless subscriber.plan}}...{{/unless}}`. Variables are always HTML-escaped; a template can prefix a tag with `html.` (`{{html.prerenderedHtml}}`) to insert a trusted HTML value unescaped. Injected HTML is sanitized (scripts, event handlers, and dangerous URLs are stripped), only applies in HTML text position, and must not contain end-user input. Likely variable issues are returned as non-blocking diagnostics when possible; missing required variables without defaults render as empty strings and do not block sending.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;transactional-&gt;update($idOrSlug, $request) -> ?UpdateTransactionalResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates transactional email metadata and labels or replaces the linked email body using raw HTML or Sequenzy blocks. Code-managed emails (`managedBy: code`, created by sends with `trackAs`) accept only `name`, `enabled` and `labels`; their content comes from each send, so `subject`, `previewText`, `html` and `blocks` return 400.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->transactional->update(
    'welcome-email',
    new UpdateTransactionalRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$idOrSlug:** `string` — Transactional email ID or slug
    
</dd>
</dl>

<dl>
<dd>

**$enabled:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$labels:** `?array` — Company label names. Trimmed and deduplicated; missing names are created. Replaces all assignments; [] clears them. Omit to preserve assignments on update or start without labels on create. Null and blank names are rejected.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$previewText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$subject:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Warehouse Sync
<details><summary><code>$client-&gt;warehouseSync-&gt;createWarehouseConnection($request) -> ?CreateWarehouseConnectionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Connects Snowflake, BigQuery, Redshift or Postgres. Sequenzy runs a test query before saving; nothing is saved when it fails. Redshift and Postgres hosts must resolve to public addresses. Requires warehouse:write.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->createWarehouseConnection(
    new CreateWarehouseConnectionRequest([
        'config' => [
            'key' => "value",
        ],
        'credentials' => [
            'key' => "value",
        ],
        'name' => 'name',
        'provider' => CreateWarehouseConnectionRequestProvider::Snowflake->value,
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$config:** `array` — Non-secret settings. snowflake: account, username, warehouse, database, schema, role. bigquery: projectId, location. redshift and postgres: host, port (default 5439 or 5432), database, username, sslMode (require or verify-full, default require).
    
</dd>
</dl>

<dl>
<dd>

**$credentials:** `array` — Secrets, stored encrypted and never returned. snowflake: privateKey (PKCS#8 PEM) and optional privateKeyPassphrase. bigquery: serviceAccountJson (the key file contents). redshift and postgres: password.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$provider:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;createWarehouseSync($request) -> ?CreateWarehouseSyncResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a sync that runs a query on a schedule and sends changed rows to Sequenzy: contacts (kind subscribers) through the import pipeline, or events on existing contacts (kind events). The mapping and cursor are checked against the query's real columns and the first run starts right away. Requires warehouse:write and subscribers:write; event syncs also need events:write, and triggerAutomations or double_opt_in need automations:trigger.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->createWarehouseSync(
    new CreateWarehouseSyncRequest([
        'connectionId' => 'connectionId',
        'kind' => CreateWarehouseSyncRequestKind::Subscribers->value,
        'mapping' => new CreateWarehouseSyncRequestMapping([]),
        'name' => 'name',
        'query' => 'query',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$connectionId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$cursorColumn:** `?string` — Column read incrementally, for example updated_at. Each run reads rows at or after the last value it saw.
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$kind:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Subscriber syncs only. Lists new contacts join.
    
</dd>
</dl>

<dl>
<dd>

**$mapping:** `CreateWarehouseSyncRequestMapping` — Subscriber syncs: emailColumn (or phoneColumn), externalIdColumn, firstNameColumn, lastNameColumn, tagsColumn, attributes. Event syncs: emailColumn or externalIdColumn, eventNameColumn or eventName, eventIdColumn, occurredAtColumn, properties. Every column must exist in the query.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$optInMode:** `?string` — Subscriber syncs only. double_opt_in needs automations:trigger.
    
</dd>
</dl>

<dl>
<dd>

**$query:** `string` — A single SELECT or WITH statement.
    
</dd>
</dl>

<dl>
<dd>

**$triggerAutomations:** `?bool` — Let new contacts, or events from the last hour, start automations. Needs automations:trigger.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;deleteWarehouseConnection($id) -> ?DeleteWarehouseConnectionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a connection and its stored credentials. Returns 409 while syncs still use it. Requires warehouse:delete.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->deleteWarehouseConnection(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;deleteWarehouseSync($id) -> ?DeleteWarehouseSyncResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes a sync and its run history. Contacts and events already imported stay. Requires warehouse:delete.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->deleteWarehouseSync(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;getWarehouseConnection($id) -> ?GetWarehouseConnectionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one connection.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->getWarehouseConnection(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;getWarehouseSync($id) -> ?GetWarehouseSyncResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one sync with its latest run.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->getWarehouseSync(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;listWarehouseConnections() -> ?ListWarehouseConnectionsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists warehouse connections with status, last test and number of syncs. Credentials are never returned. Requires warehouse:read.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->listWarehouseConnections();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;listWarehouseSyncRuns($id, $request) -> ?ListWarehouseSyncRunsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists runs from the last 30 days, newest first, with row counts, sample row problems and import progress.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->listWarehouseSyncRuns(
    'id',
    new ListWarehouseSyncRunsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;listWarehouseSyncs($request) -> ?ListWarehouseSyncsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists syncs with schedule, status, cursor position and the latest run, including progress of the subscriber imports it queued. Requires warehouse:read.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->listWarehouseSyncs(
    new ListWarehouseSyncsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$connectionId:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;previewWarehouseQuery($id, $request) -> ?PreviewWarehouseQueryResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Runs a SELECT query with a 20-row limit and returns its columns and rows, to build a sync mapping. Requires warehouse:write.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->previewWarehouseQuery(
    'id',
    new PreviewWarehouseQueryRequest([
        'query' => 'query',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$query:** `string` — A single SELECT or WITH statement.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;runWarehouseSync($id, $request) -> ?RunWarehouseSyncResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a run now. Only one run per sync executes at a time; a request made while a run is in progress runs right after it. With fullResync, the run forgets which rows were sent and the cursor position, and sends every row again. A full resync of a sync that starts automations or sends double opt-in emails needs automations:trigger.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->runWarehouseSync(
    'id',
    new RunWarehouseSyncRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$fullResync:** `?bool` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;testWarehouseConnection($id) -> ?TestWarehouseConnectionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Runs a test query with the stored credentials and records the result on the connection.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->testWarehouseConnection(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;updateWarehouseConnection($id, $request) -> ?UpdateWarehouseConnectionResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Renames a connection, changes its settings or rotates its credentials. Settings and credential changes are re-tested before saving.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->updateWarehouseConnection(
    'id',
    new UpdateWarehouseConnectionRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$config:** `?array` — Settings to change; merged with the saved settings.
    
</dd>
</dl>

<dl>
<dd>

**$credentials:** `?array` — Replacement credentials. Omit to keep the stored ones.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;warehouseSync-&gt;updateWarehouseSync($id, $request) -> ?UpdateWarehouseSyncResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Changes a sync. Omitted fields keep their current values. Query, mapping and cursor changes are checked against the query's columns; a changed query or cursor reads from the beginning again, while unchanged rows are still skipped. Other changes do not contact the warehouse. Saving makes the caller the user imports run as. On a sync that starts automations or sends double opt-in emails, changing the query, mapping, cursor or lists needs automations:trigger. A run in progress stops at its next page and runs again with the new settings.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->warehouseSync->updateWarehouseSync(
    'id',
    new UpdateWarehouseSyncRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$cursorColumn:** `?string` — Column read incrementally, for example updated_at. Each run reads rows at or after the last value it saw.
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?string` — manual cancels the next scheduled run.
    
</dd>
</dl>

<dl>
<dd>

**$isEnabled:** `?bool` — false pauses the sync, true resumes it.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Subscriber syncs only. Lists that contacts the sync creates join; existing contacts keep their list memberships.
    
</dd>
</dl>

<dl>
<dd>

**$mapping:** `?UpdateWarehouseSyncRequestMapping` — Subscriber syncs: emailColumn (or phoneColumn), externalIdColumn, firstNameColumn, lastNameColumn, tagsColumn, attributes. Event syncs: emailColumn or externalIdColumn, eventNameColumn or eventName, eventIdColumn, occurredAtColumn, properties. Every column must exist in the query.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$optInMode:** `?string` — Subscriber syncs only. double_opt_in needs automations:trigger.
    
</dd>
</dl>

<dl>
<dd>

**$query:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$triggerAutomations:** `?bool` — Let new contacts, or events from the last hour, start automations. Needs automations:trigger.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Webhooks
<details><summary><code>$client-&gt;webhooks-&gt;addSigningSecret($id) -> ?AddSigningSecretWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds another active signing secret. Requests are signed once per active secret in the same signature header.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->addSigningSecret(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;create($request) -> ?CreateWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates an outbound webhook endpoint. The signing secret is returned only in this response.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->create(
    new CreateWebhooksRequest([
        'name' => 'Production webhook',
        'url' => 'https://example.com/sequenzy/webhooks',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$events:** `?array` — Omit to subscribe to default email and SMS lifecycle events plus subscriber.invalid, subscriber.created, and subscriber.unsubscribed. Add campaign.sent, email.opened, email.clicked, email.replied, subscriber.updated, subscriber.list_subscribed, subscriber.list_unsubscribed, sequence.finished, and sequence.failed explicitly for aggregate campaign completion, engagement, inbound reply, profile sync, per-list consent sync, or sequence lifecycle events. SMS events (sms.sent, sms.delivered, sms.failed, sms.opted_out) are included in the defaults.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$url:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;delete($id) -> ?DeleteWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently deletes an outbound webhook endpoint along with its delivery history. To keep the endpoint but stop deliveries, use PATCH with status "disabled" instead.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->delete(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;list() -> ?ListWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists customer-configured outbound webhook endpoints for the authenticated company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;listDeliveries($id, $request) -> ?ListDeliveriesWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists recent delivery attempts for an outbound webhook endpoint.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->listDeliveries(
    'id',
    new ListDeliveriesWebhooksRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;listDeliveryAttempts($id, $deliveryId) -> ?ListDeliveryAttemptsWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the latest HTTP attempt summary for a webhook delivery.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->listDeliveryAttempts(
    'id',
    'deliveryId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$deliveryId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;removeSigningSecret($id, $secretId) -> ?RemoveSigningSecretWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes an active signing secret. A webhook must keep at least one signing secret.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->removeSigningSecret(
    'id',
    'secretId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$secretId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;replayDelivery($id, $deliveryId) -> ?ReplayDeliveryWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a webhook delivery for another signed POST attempt and resets stored endpoint failure state.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->replayDelivery(
    'id',
    'deliveryId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$deliveryId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;test($id) -> ?TestWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Queues a test delivery for a webhook endpoint and resets stored endpoint failure state. The test is delivered to this endpoint even when the endpoint subscribes to no event types, and the queued delivery is returned so you can poll its status without waiting for it to appear in the delivery list.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->test(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webhooks-&gt;update($id, $request) -> ?UpdateWebhooksResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an outbound webhook endpoint URL, name, status, or subscribed events. Changing the URL or enabling the endpoint resets stored endpoint failure state, including `failingSince` and `autoDisabledAt`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webhooks->update(
    'id',
    new UpdateWebhooksRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$events:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$url:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Websites
<details><summary><code>$client-&gt;websites-&gt;add($request) -> ?AddWebsitesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it on its root (links.<root>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->websites->add(
    new AddWebsitesRequest([
        'domain' => 'domain',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `string` — Domain to add.
    
</dd>
</dl>

<dl>
<dd>

**$mailFromPrefix:** `?string` — Bounce (MAIL FROM) subdomain label. Defaults to send. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved. Applies only when the domain is created; re-adding an existing domain returns its stored records.
    
</dd>
</dl>

<dl>
<dd>

**$trackingPrefix:** `?string` — Label of the company tracking domain created on the domain's root (<label>.<root>) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;websites-&gt;configureSendingDomainTracking($domain, $request) -> ?ConfigureSendingDomainTrackingResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deprecated: tracking is company-wide; use PUT /tracking-domain. Sets <trackingPrefix>.<domain> as the company tracking domain when the company has none. Publish the returned tracking.cnameRecord; sending never waits for it, and links use the shared Sequenzy tracking domain until it verifies. Repeating the company's current tracking hostname is a no-op. A different value is accepted but changes nothing, and the response message says so; it never replaces the company setting.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->websites->configureSendingDomainTracking(
    'domain',
    new ConfigureSendingDomainTrackingRequest([
        'trackingPrefix' => 'trackingPrefix',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `string` — Configured sending domain
    
</dd>
</dl>

<dl>
<dd>

**$trackingPrefix:** `string` — Tracking subdomain label, for example links. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;websites-&gt;get($domain) -> ?GetWebsitesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns verification status and DNS records for a sending domain.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->websites->get(
    'domain',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `string` — Sending domain
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;websites-&gt;list() -> ?ListWebsitesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists sending domains configured for the authenticated company.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->websites->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;websites-&gt;verifySendingDomain($domain) -> ?VerifySendingDomainResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Runs a fresh DNS and provider verification and returns normalized aggregate, SPF, DKIM, and MAIL FROM status and diagnostics. For legacy custom reply domains, once the inbound MX is verified this also prepares any required public verification TXT record in website.dnsRecords.inboundVerificationRecord. Publish that record and retry this endpoint; existing reply hostnames are preserved. Inspect dnsRecords.inboundRoutingStatus independently of readyToSend.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->websites->verifySendingDomain(
    'domain',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$domain:** `string` — Configured sending domain
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Web Tracking Keys
<details><summary><code>$client-&gt;webTrackingKeys-&gt;create($request) -> ?CreateWebTrackingKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins - an empty allowlist accepts events from any site. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webTrackingKeys->create(
    new CreateWebTrackingKeysRequest([
        'name' => 'name',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$allowedOrigins:** `?array` — Origins allowed to use this key. A bare domain is read as https. A leading *. matches subdomains at any depth but not the apex. Omitting this leaves the key unrestricted.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` — Human-readable label, e.g. Storefront.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webTrackingKeys-&gt;delete($id) -> ?DeleteWebTrackingKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently deletes a web tracking key. Cached authorization expires within one minute, after which requests from a remaining snippet are rejected. Remove the snippet as well. Prefer revoking with isActive false when the key may be needed again. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webTrackingKeys->delete(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Web tracking key ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webTrackingKeys-&gt;get($id) -> ?GetWebTrackingKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one web tracking key with its install snippet and ingest endpoint. The snippet embeds both the publishable key and the workspace id, so use it as returned rather than rebuilding it. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webTrackingKeys->get(
    'id',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Web tracking key ID.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webTrackingKeys-&gt;list() -> ?ListWebTrackingKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists the publishable keys that let a website send on-site events (product views, cart activity, collection views, search) into this workspace. Each key includes a paste-ready install snippet and its origin allowlist. A key whose lastUsedAt is null has not successfully authenticated an event yet; it may be undeployed, have no instrumented traffic, or be sending requests rejected by its origin allowlist. Shopify stores use the storefront pixel instead. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webTrackingKeys->list();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webTrackingKeys-&gt;mintIdentity($request) -> ?MintIdentityWebTrackingKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Mints a short-lived HMAC proof bound to one active web tracking key, workspace, and normalized email. Identify the key by keyId or by its publishable publicKey value. If the email is not yet a contact, one is created (active, no lists, no automations triggered) so identified events are attributed instead of being silently dropped. Call this only from an authenticated backend; never expose the secret API key in browser code. Identified browser events without this proof are rejected before queueing. Requires commerce:write, automations:trigger, and subscribers:write (minting can create the contact).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webTrackingKeys->mintIdentity(
    new MintIdentityWebTrackingKeysRequest([
        'email' => 'email',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$keyId:** `?string` — Internal web tracking key ID. Provide this or publicKey.
    
</dd>
</dl>

<dl>
<dd>

**$publicKey:** `?string` — Publishable key value (seq_pk_...). Provide this or keyId.
    
</dd>
</dl>

<dl>
<dd>

**$ttlHours:** `?float` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;webTrackingKeys-&gt;update($id, $request) -> ?UpdateWebTrackingKeysResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Renames a key, replaces its allowed origins, or revokes it. allowedOrigins replaces the whole list rather than appending. Revoking stops events within about a minute while preserving the key value, so the matching snippet can still be found and removed from the site. Requires the integrations:manage scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->webTrackingKeys->update(
    'id',
    new UpdateWebTrackingKeysRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$id:** `string` — Web tracking key ID.
    
</dd>
</dl>

<dl>
<dd>

**$allowedOrigins:** `?array` — Replacement allowlist. Pass an empty array to make the key unrestricted.
    
</dd>
</dl>

<dl>
<dd>

**$isActive:** `?bool` — Set false to revoke the key, true to re-enable a revoked one.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Widgets
<details><summary><code>$client-&gt;widgets-&gt;createSavedForm($request) -> ?CreateSavedFormResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates and publishes a saved signup form. Its opaque form ID becomes a client-safe public capability while audience and success settings remain server-side.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->createSavedForm(
    new CreateSavedFormRequest([
        'listIds' => [
            'listIds',
        ],
        'name' => 'name',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$buttonText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$headline:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `array` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$redirectUrl:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$resubscribeBehavior:** `?string` — What happens when a contact who unsubscribed from all email submits this form again. `reactivate` resubscribes them and restores the form's lists. `double_opt_in` sends the workspace confirmation email first and resubscribes them when they confirm. Turning it on requires a double opt-in confirmation email and a sender profile, otherwise the request returns 400; if either is removed later, returning unsubscribed contacts stay unsubscribed. Workspace double opt-in always requires confirmation. `duplicateStrategy` never changes subscription status.
    
</dd>
</dl>

<dl>
<dd>

**$showFirstName:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$showLastName:** `?bool` 
    
</dd>
</dl>

<dl>
<dd>

**$successMessage:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$tagIds:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$theme:** `?array` — Optional visual theme overrides (accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor as "#rrggbb", borderRadius 0-32, headingFontFamily, bodyFontFamily, density).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;createSavedPopup($request) -> ?CreateSavedPopupResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a saved on-site signup popup and returns the one-line script tag that deploys it. The popup is published by default, so the script is live as soon as it is added to the site. Trigger, targeting, audience, and duplicate handling stay server-side, so the deployed script carries no API key.

Omit `listIds` to capture into every list, matching the dashboard default.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->createSavedPopup(
    new CreateSavedPopupRequest([
        'name' => 'name',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$blocks:** `?array` — Complete replacement for the popup's content blocks. The popup must keep exactly one required email field and one submit button.
    
</dd>
</dl>

<dl>
<dd>

**$buttonText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?SavedPopupFrequency` 
    
</dd>
</dl>

<dl>
<dd>

**$headline:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Lists every signup is added to. Omit or pass an empty array to capture into every list.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$placement:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$presentation:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$redirectUrl:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$resubscribeBehavior:** `?string` — What happens when a contact who unsubscribed from all email submits this popup again. `reactivate` resubscribes them and restores the popup's lists. `double_opt_in` sends the workspace confirmation email first and resubscribes them when they confirm. Turning it on requires a double opt-in confirmation email and a sender profile, otherwise the request returns 400; if either is removed later, returning unsubscribed contacts stay unsubscribed. Workspace double opt-in always requires confirmation. `duplicateStrategy` never changes subscription status.
    
</dd>
</dl>

<dl>
<dd>

**$schedule:** `?SavedPopupSchedule` 
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$successMessage:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$tagIds:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$targeting:** `?SavedPopupTargeting` 
    
</dd>
</dl>

<dl>
<dd>

**$template:** `?string` — Starting design for the popup's blocks and theme.
    
</dd>
</dl>

<dl>
<dd>

**$theme:** `?array` — Optional visual theme overrides (accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor as "#rrggbb", borderRadius 0-32, headingFontFamily, bodyFontFamily, density).
    
</dd>
</dl>

<dl>
<dd>

**$trigger:** `?SavedPopupTrigger` 
    
</dd>
</dl>

<dl>
<dd>

**$visual:** `?SavedPopupVisual` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;deleteSavedPopup($popupId) -> ?DeleteSavedPopupResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently deletes a saved popup along with its view and conversion counts. Subscribers it already captured are not affected. To stop a popup from showing while keeping its stats, set its status to draft instead.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->deleteSavedPopup(
    'popupId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$popupId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;duplicateSavedPopup($popupId, $request) -> ?DuplicateSavedPopupResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Copies a saved popup into a new draft with its own view and conversion counts. The original keeps its status and stats, so a live popup carries on showing while the copy is edited.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->duplicateSavedPopup(
    'popupId',
    new DuplicateSavedPopupRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$popupId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` — Name for the copy. Defaults to the original name with " (copy)" appended.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;getCompanyScopedSavedSignupFormEmbedScript($companyIdOrFormId, $formId)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Compatibility path for saved signup form embed scripts. New embeds should use `/forms/{formId}/embed.js`.

The script renders the current saved form settings when the page loads, so dashboard edits apply to deployed JavaScript embeds without copying new HTML.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->getCompanyScopedSavedSignupFormEmbedScript(
    'companyIdOrFormId',
    'formId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyIdOrFormId:** `string` — The company ID the form belongs to
    
</dd>
</dl>

<dl>
<dd>

**$formId:** `string` — The saved form ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;getPopupWidgetRuntime()</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Load the hosted JavaScript runtime for popup signup widgets. No API key is required.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->getPopupWidgetRuntime();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;getSavedFormEmbed($formId) -> ?GetSavedFormEmbedResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a published saved form's public action URL, hosted JavaScript, minimal native form, fetch enhancement, and supported static-site platforms.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->getSavedFormEmbed(
    'formId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$formId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;getSavedPopup($popupId) -> ?GetSavedPopupResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one saved popup with its complete content blocks, trigger, targeting, schedule, frequency, and theme. Read this before replacing blocks so the replacement array stays complete.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->getSavedPopup(
    'popupId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$popupId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;getSavedPopupEmbed($popupId) -> ?GetSavedPopupEmbedResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns a published popup's script URL plus ready-to-paste snippets for plain HTML, React and Next.js, WordPress, and Shopify. The snippets carry no API key.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->getSavedPopupEmbed(
    'popupId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$popupId:** `string` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;getSavedSignupFormEmbedScript($companyIdOrFormId)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Load a saved signup form with one line of JavaScript. No API key is required.

The script renders the current saved form settings when the page loads, so dashboard edits apply to deployed JavaScript embeds without copying new HTML.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->getSavedSignupFormEmbedScript(
    'companyIdOrFormId',
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyIdOrFormId:** `string` — The saved form ID
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;listCaptureSubmissions($sourceType, $sourceId, $request) -> ?ListCaptureSubmissionsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Read immutable accepted answers for a form, popup or landing page. Requires subscribers:read plus widgets:read for forms/popups or landing_pages:read for landing pages. History is forward-only; deleting a subscriber, source or company removes associated records. Reads can be retried safely.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->listCaptureSubmissions(
    ListCaptureSubmissionsRequestSourceType::Form->value,
    'sourceId',
    new ListCaptureSubmissionsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$sourceType:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$sourceId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$cursor:** `?string` — nextCursor from the previous page, keeping the same filters.
    
</dd>
</dl>

<dl>
<dd>

**$field:** `?string` — Exact custom attribute key; requires value. Omit both to clear filtering.
    
</dd>
</dl>

<dl>
<dd>

**$format:** `?string` — csv adds a CSV string for this page; the response remains JSON.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$value:** `?string` — Exact scalar answer or string array member; requires field. Empty string is allowed.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;listFormSubmissions($companyIdOrFormId, $request) -> ?ListFormSubmissionsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Form-only alias for GET /submissions/form/{formId}. Requires widgets:read and subscribers:read. Returns immutable accepted answers recorded since tracking began. Reads can be retried safely.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->listFormSubmissions(
    'companyIdOrFormId',
    new ListFormSubmissionsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyIdOrFormId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$cursor:** `?string` — nextCursor from the previous page, keeping the same filters.
    
</dd>
</dl>

<dl>
<dd>

**$field:** `?string` — Exact custom attribute key; requires value. Omit both to clear filtering.
    
</dd>
</dl>

<dl>
<dd>

**$format:** `?string` — csv adds a CSV string for this page; the response remains JSON.
    
</dd>
</dl>

<dl>
<dd>

**$limit:** `?int` 
    
</dd>
</dl>

<dl>
<dd>

**$value:** `?string` — Exact scalar answer or string array member; requires field. Empty string is allowed.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;listSavedForms() -> ?ListSavedFormsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists saved signup forms for the authenticated workspace, including their server-managed audience settings and public action URLs.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->listSavedForms();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;listSavedPopups($request) -> ?ListSavedPopupsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Lists saved on-site signup popups for the authenticated workspace, including their trigger, targeting, audience settings, and view and conversion counts.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->listSavedPopups(
    new ListSavedPopupsRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$includeContent:** `?string` — Set to `true` to include every popup's full content blocks. Omitted by default because each popup adds roughly 1.8k characters; read one popup with `GET /popups/{popupId}` instead.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;submitCompanyScopedSavedSignupForm($companyIdOrFormId, $formId, $request) -> ?SubmitCompanyScopedSavedSignupFormResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Compatibility path for saved signup form submissions. New embeds should use `/forms/{formId}`.

The form's stored settings are the source of truth for audience targeting (lists, tags) and success behavior (success message or redirect URL), so dashboard edits apply to deployed embeds without re-embedding. List, tag, and redirect values in the request are ignored.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->submitCompanyScopedSavedSignupForm(
    'companyIdOrFormId',
    'formId',
    new SubmitCompanyScopedSavedSignupFormRequest([
        'email' => 'user@example.com',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyIdOrFormId:** `string` — The company ID the form belongs to
    
</dd>
</dl>

<dl>
<dd>

**$formId:** `string` — The saved form ID
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Subscriber custom attributes for custom fields configured on the saved form
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategyToken:** `?string` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `string` — Subscriber email address
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$listIdsBracketed:** `?array` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Subscriber phone number in E.164 or US national format, when configured on the saved form. Stored on the base subscriber profile and does not grant SMS consent.
    
</dd>
</dl>

<dl>
<dd>

**$redirectUrl:** `?string` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$sequenzyToken:** `?string` — Signed bot-protection token that Sequenzy's hosted embed script and popups add automatically. Custom integrations can omit it. Submissions without a valid token may be asked to confirm by email. Workspaces with strict protection ignore submissions without a token, or with a token for a different form or popup, and return the normal success response.
    
</dd>
</dl>

<dl>
<dd>

**$tagIds:** `?array` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$tagIdsBracketed:** `?array` — Ignored for saved forms. Stored form settings are used.
    
</dd>
</dl>

<dl>
<dd>

**$website:** `?string` — Honeypot field. Leave empty.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;submitSavedPopup($popupId, $request) -> ?SubmitSavedPopupResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Submit a saved popup without an API key. The popup's stored content is the source of truth for audience targeting, duplicate handling, resubscribe behavior, custom fields, and success behavior.

A contact who unsubscribed from all email is resubscribed and their target list memberships are restored. When the popup's `resubscribeBehavior` is `double_opt_in`, or workspace double opt-in is on, they receive a confirmation email instead. The response does not reveal which case applied.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->submitSavedPopup(
    'popupId',
    new SubmitSavedPopupRequest([
        'email' => 'user@example.com',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$popupId:** `string` — The saved popup ID
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Subscriber custom attributes for custom fields configured on the popup
    
</dd>
</dl>

<dl>
<dd>

**$email:** `string` — Subscriber email address
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Subscriber phone number in E.164 or US national format, when configured on the popup. Stored on the base subscriber profile and does not grant SMS consent.
    
</dd>
</dl>

<dl>
<dd>

**$sequenzyToken:** `?string` — Signed bot-protection token that Sequenzy's hosted embed script and popups add automatically. Custom integrations can omit it. Submissions without a valid token may be asked to confirm by email. Workspaces with strict protection ignore submissions without a token, or with a token for a different form or popup, and return the normal success response.
    
</dd>
</dl>

<dl>
<dd>

**$website:** `?string` — Honeypot field. Leave empty.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;submitSignupForm($companyIdOrFormId, $request) -> ?SubmitSignupFormResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Submit a public signup form. No API key is required.

When the path value is a saved form ID, the form's stored settings are used for audience targeting and success behavior. When the path value is a company ID, this endpoint uses the legacy company-level form behavior.

Omit `lists` to use the workspace default lists setting, provide `lists=` to add the subscriber to no lists, or provide comma-separated list IDs for specific lists. Provide stable `tags` IDs to apply existing tags to the subscriber.

Submitting again is a fresh opt-in. A contact who unsubscribed from all email is resubscribed and their target list memberships are restored, whatever the `duplicateStrategy`. When the saved form's `resubscribeBehavior` is `double_opt_in`, or workspace double opt-in is on, they receive a confirmation email instead and are resubscribed when they confirm. Contacts whose address bounced or who marked your email as spam are not resubscribed. The response is the same in every case, so it does not reveal whether an address was subscribed.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->submitSignupForm(
    'companyIdOrFormId',
    new SubmitSignupFormRequest([
        'lists' => 'list_abc123,list_def456',
        'tags' => 'tag_abc123,tag_def456',
        'email' => 'user@example.com',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyIdOrFormId:** `string` — A saved form ID, or a company ID for legacy generated forms
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` — How to handle profile fields of an existing contact with the submitted email. Use skip to preserve fields, merge to fill missing fields, or overwrite to replace submitted fields. Merge and overwrite require duplicateStrategyToken from the form builder. Does not affect whether an unsubscribed contact is resubscribed.
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategyToken:** `?string` — Signed token generated by the form builder for the selected duplicateStrategy. Required for merge or overwrite.
    
</dd>
</dl>

<dl>
<dd>

**$lists:** `?string` — Comma-separated list IDs. Omit for workspace default lists, or provide an empty value for no lists.
    
</dd>
</dl>

<dl>
<dd>

**$tags:** `?string` — Comma-separated tag IDs to apply to the subscriber.
    
</dd>
</dl>

<dl>
<dd>

**$customAttributes:** `?array` — Subscriber custom attributes
    
</dd>
</dl>

<dl>
<dd>

**$bodyDuplicateStrategy:** `?string` — Body alternative to the duplicateStrategy query parameter. Query parameter takes precedence. Merge and overwrite require duplicateStrategyToken.
    
</dd>
</dl>

<dl>
<dd>

**$bodyDuplicateStrategyToken:** `?string` — Body alternative to the duplicateStrategyToken query parameter.
    
</dd>
</dl>

<dl>
<dd>

**$email:** `string` — Subscriber email address
    
</dd>
</dl>

<dl>
<dd>

**$firstName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$lastName:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$phone:** `?string` — Subscriber phone number in E.164 or US national format. Stored on the base subscriber profile and does not grant SMS consent.
    
</dd>
</dl>

<dl>
<dd>

**$redirectUrl:** `?string` — Http(s) URL or bare domain to redirect to after successful submission
    
</dd>
</dl>

<dl>
<dd>

**$sequenzyToken:** `?string` — Signed bot-protection token that Sequenzy's hosted embed script and popups add automatically. Custom integrations can omit it. Submissions without a valid token may be asked to confirm by email. Workspaces with strict protection ignore submissions without a token, or with a token for a different form or popup, and return the normal success response.
    
</dd>
</dl>

<dl>
<dd>

**$tagIds:** `?array` — Existing tag IDs to apply to the subscriber
    
</dd>
</dl>

<dl>
<dd>

**$website:** `?string` — Honeypot field. Leave empty.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;updateSavedForm($companyIdOrFormId, $request) -> ?UpdateSavedFormResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a saved form's name, audience targeting, copy, visual theme, or content blocks. Every field is optional - send only what should change.

The `headline`, `description`, `buttonText`, and `successMessage` fields edit the matching content block and fail with 400 when the form has no such block; replace `blocks` for structural changes. The `blocks` array fully replaces the form's content blocks and must keep exactly one required email field and one submit button. An empty `redirectUrl` switches the form back to its confirmation message.

Blocks render in array order and each needs a unique `id` and a `kind`. Input blocks use `kind: "form-field"` with `fieldType` (text, email, phone, number, textarea, select, radio, checkbox, consent, hidden), `name` (the custom attribute key), `label`, `placeholder`, `required`, `defaultValue`, `showLabel`, `width` (full or half), `mapsTo` (email, firstName, lastName, phone, customAttribute; defaults to customAttribute), and `options` for choice fields (`[{ value, label, id }]`, where label and id default to value). A hidden field with a `defaultValue` stores that server-owned value and ignores submitted values; a hidden field without one stores the value the page submits. Validation errors name the offending property, for example `blocks[3].options[0].value`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->updateSavedForm(
    'companyIdOrFormId',
    new UpdateSavedFormRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$companyIdOrFormId:** `string` — The saved form ID to update
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` — Full replacement for the form's content blocks.
    
</dd>
</dl>

<dl>
<dd>

**$buttonText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$headline:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` 
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$redirectUrl:** `?string` — HTTP or HTTPS success redirect. An empty string switches back to the confirmation message.
    
</dd>
</dl>

<dl>
<dd>

**$resubscribeBehavior:** `?string` — What happens when a contact who unsubscribed from all email submits this form again. `reactivate` resubscribes them and restores the form's lists. `double_opt_in` sends the workspace confirmation email first and resubscribes them when they confirm. Turning it on requires a double opt-in confirmation email and a sender profile, otherwise the request returns 400; if either is removed later, returning unsubscribed contacts stay unsubscribed. Workspace double opt-in always requires confirmation. `duplicateStrategy` never changes subscription status.
    
</dd>
</dl>

<dl>
<dd>

**$successMessage:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$tagIds:** `?array` — Replacement tag IDs. An empty array clears tags.
    
</dd>
</dl>

<dl>
<dd>

**$theme:** `?array` — Visual theme overrides merged into the current theme (accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor as "#rrggbb", borderRadius 0-32, headingFontFamily, bodyFontFamily, density).
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>$client-&gt;widgets-&gt;updateSavedPopup($popupId, $request) -> ?UpdateSavedPopupResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates a saved popup. Only the fields you send change.

Set `status` to `published` to make the popup live, or `draft` to stop it showing while keeping the popup, its stats, and its embed script. `trigger`, `targeting`, `schedule`, `frequency`, and `visual` are merged key by key, so patching one key keeps the rest.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->updateSavedPopup(
    'popupId',
    new UpdateSavedPopupRequest([]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$popupId:** `string` 
    
</dd>
</dl>

<dl>
<dd>

**$blocks:** `?array` — Complete replacement for the popup's content blocks. The popup must keep exactly one required email field and one submit button.
    
</dd>
</dl>

<dl>
<dd>

**$buttonText:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$description:** `?string` — New text for the popup's first paragraph block. Fails when the popup has no paragraph block.
    
</dd>
</dl>

<dl>
<dd>

**$duplicateStrategy:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$frequency:** `?SavedPopupFrequency` 
    
</dd>
</dl>

<dl>
<dd>

**$headline:** `?string` — New text for the popup's first heading block. Fails when the popup has no heading block.
    
</dd>
</dl>

<dl>
<dd>

**$listIds:** `?array` — Replacement list targeting. Pass an empty array to capture into every list.
    
</dd>
</dl>

<dl>
<dd>

**$name:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$placement:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$presentation:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$redirectUrl:** `?string` — HTTP or HTTPS URL for successful signups. Pass an empty string to switch back to the confirmation message.
    
</dd>
</dl>

<dl>
<dd>

**$resubscribeBehavior:** `?string` — What happens when a contact who unsubscribed from all email submits this popup again. `reactivate` resubscribes them and restores the popup's lists. `double_opt_in` sends the workspace confirmation email first and resubscribes them when they confirm. Turning it on requires a double opt-in confirmation email and a sender profile, otherwise the request returns 400; if either is removed later, returning unsubscribed contacts stay unsubscribed. Workspace double opt-in always requires confirmation. `duplicateStrategy` never changes subscription status.
    
</dd>
</dl>

<dl>
<dd>

**$schedule:** `?SavedPopupSchedule` 
    
</dd>
</dl>

<dl>
<dd>

**$status:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$successMessage:** `?string` 
    
</dd>
</dl>

<dl>
<dd>

**$tagIds:** `?array` — Replacement tag IDs. Pass an empty array to clear tags.
    
</dd>
</dl>

<dl>
<dd>

**$targeting:** `?SavedPopupTargeting` 
    
</dd>
</dl>

<dl>
<dd>

**$theme:** `?array` — Visual theme overrides merged into the current theme.
    
</dd>
</dl>

<dl>
<dd>

**$trigger:** `?SavedPopupTrigger` 
    
</dd>
</dl>

<dl>
<dd>

**$visual:** `?SavedPopupVisual` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Widgets Preferences
<details><summary><code>$client-&gt;widgets-&gt;preferences-&gt;generateToken($request) -> ?GenerateTokenPreferencesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Generate a signed token to embed the subscription preferences widget for a subscriber.
This token allows users to manage their email subscription preferences directly from your website.

**Important:** Call this endpoint from your backend only. Never expose your API key to the frontend.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```php
$client->widgets->preferences->generateToken(
    new GenerateTokenPreferencesRequest([
        'email' => 'user@example.com',
    ]),
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**$email:** `string` — The subscriber's email address
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>