---
schema_version: "1"
id: c44236c26abbc415c4ab837f81e17685e65a6fe5c42343b79f101f181f4ce1a1
title: UnsubEvent
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/unsubevent.md
canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/unsubevent.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: c38e43bf41c9bd8db537c5b647e3b1a0a59d3d151983adb354b891262f3c7265
products:
  - Marketing Cloud Engagement APIs and Programmatic Languages
  - Marketing Cloud
---
# UnsubEvent

Contains information regarding a specific unsubscribe action taken by a subscriber.

## Properties

| Name                              | Data Type                                      | Description                                                                                                                                                                  |
| --------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BatchID`                         | Int                                            | Ties triggered send sent events to other events (like clicks and opens that occur at a later date and time).                                                                 |
| `Client`                          | [ClientID](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/clientid.md)                        | Specifies the account ownership and context of an object.                                                                                                                    |
| `CorrelationID`                   | String                                         | Identifies correlation of objects across several requests.                                                                                                                   |
| `CreatedDate`                     | DateTime                                       | The date and time when the object was created.                                                                                                                               |
| `CustomerKey`                     | String                                         | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.                                    |
| `EventDate`                       | DateTime                                       | Date when a tracking event occurred.                                                                                                                                         |
| `EventType`                       | [EventType](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/eventtype.md)                      | The type of tracking event.                                                                                                                                                  |
| `ID`                              | Int                                            | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID.                                                                                   |
| `IsMasterUnsubscribed`            | Boolean                                        | Indicates whether the subscriber master unsubscribed.                                                                                                                        |
| `List`                            | [List](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/list.md)                                | Indicates the list involved in the unsubscription.                                                                                                                           |
| `ModifiedDate`                    | DateTime                                       | The date and time when the object was last modified.                                                                                                                         |
| `ObjectID`                        | String                                         | System-controlled, read-only text string identifier for object.                                                                                                              |
| `ObjectState`                     | String                                         | Reserved for future use.                                                                                                                                                     |
| `Owner`                           | [Owner](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/owner.md)                              | Describes account ownership of subscriber in an on-your-behalf account.                                                                                                      |
| `PartnerKey`                      | String                                         | Unique identifier provided by partner for an object. This property is accessible only via API.                                                                               |
| `PartnerProperties`               | Array of [APIProperty](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/apiproperty.md) objects | A collection of metadata supplied by client and stored by system. This property is accessible only via API.                                                                  |
| `SendID`                          | Int                                            | Contains identifier for a specific send.                                                                                                                                     |
| `SubscriberKey`                   | String                                         | Identification of a specific subscriber.                                                                                                                                     |
| `TriggeredSendDefinitionObjectID` | String                                         | Identifies the triggered send definition associated with an event. This value also appears in tracking events to allow you to tie those events to a specific triggered send. |

## Related Items

- [Supported Operations for Objects and Methods](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/supported_operations_for_objects_and_methods.md)