> For the complete documentation index, see [llms.txt](https://api.senderwiz.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.senderwiz.com/customer/reports/track-subscriber-unsubscribe.md).

# Track Subscriber Unsubscribe

Log an unsubscribe action from a subscriber for a specific campaign, optionally capturing metadata such as IP address, user agent, and reason.

### 🚫 Track Subscriber Unsubscribe

Use this endpoint to register an unsubscribe event for a specific subscriber from a campaign.

***

#### 🔹 HTTP Request

```http
POST API-URL/campaigns/CAMPAIGN-UNIQUE-ID/track-unsubscribe/SUBSCRIBER-UNIQUE-ID
```

***

#### 🔸 URL Segments

| Segment                | Required | Description                  |
| ---------------------- | -------- | ---------------------------- |
| `CAMPAIGN-UNIQUE-ID`   | Yes      | Unique ID of the campaign.   |
| `SUBSCRIBER-UNIQUE-ID` | Yes      | Unique ID of the subscriber. |

***

#### 📝 POST Parameters

| Parameter    | Required | Description                          |
| ------------ | -------- | ------------------------------------ |
| `ip_address` | No       | IP address of the subscriber.        |
| `user_agent` | No       | User agent string of the subscriber. |
| `reason`     | No       | Optional reason for unsubscribing.   |

***

#### 🔐 Authorization Header

```
X-API-KEY: your-api-key-here
```

***

#### 💻 PHP Example

```php
// Track subscriber unsubscribe for campaign
$response = $endpoint->trackUnsubscribe('CAMPAIGN-UNIQUE-ID', 'SUBSCRIBER-UNIQUE-ID', [
    'ip_address' => '231.134.23.13',
    'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36',
    'reason'     => 'Reason for unsubscribe!',
]);

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';
```

***

#### 📦 Sample JSON Response

```json
{
  "status": "success",
  "data": {}
}
```