--- schema_version: "1" id: 3735bcc6a765548c104915bd64863323f6ac6a49295342ce8a0f490282997d10 title: Subscriber collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/subscriber.md canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/subscriber.html source_site: developer.salesforce.com content_type: documentation content_hash: ac470a80af1828778a766e75124968c1736069e5e34fdd1f66308e1a8f48a0ae products: - Marketing Cloud Engagement APIs and Programmatic Languages - Marketing Cloud --- # Subscriber The Subscriber object is a single instance of a person subscribed to receive email or SMS communication. When using the Describe method on a Subscriber object, the ExtendedProperties property contains the definitions for all of the data profile and preference attributes defined by a client. - To update a Subscriber with a SubscriberType of 1 or 2 and a SFIntegrationVersion less than 2, you need the Email | Integrations | Salesforce CRM | Resubscribe permission. - To update a Subscriber with a SubscriberType of 4, 5, or 6 and the MSCRMIntegration feature enabled, you need the Email | Integrations | Microsoft CRM | Resubscribe permission. ## Required Attributes - All Subscriber objects require at minimum a value for EmailAddress (and SubscriberKey, if that feature is enabled for your account) for Create calls involving email messages. - For SMS subscribers, you must include a valid value for SubscriberKey. - For Update and Delete calls, you must identify the subscriber via a valid EmailAddress, SubscriberKey, or ID. - In addition, include any attributes required by your account. - All Subscriber objects in Enterprise accounts must contain a value for a valid On-Your-Behalf account in the ChannelMemberID property. - Review your error messages for more required attributes if necessary. ## Properties | Name | Data Type | Description | | ----------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `Addresses` | Array of [SubscriberAddress](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/subscriberaddress.md) objects | Indicates addresses belonging to a subscriber, used to create, retrieve, update or delete an email or SMS Address for a given subscriber. | | `Attributes` | Array of [Attribute](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/attribute.md) objects | Specifies attributes associated with an object. | | `Client` | [ClientID](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/clientid.md) object | 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. | | `EmailAddress` | String | Contains the email address for a subscriber. Indicates the data extension field contains email address data. | | `EmailTypePreference` | [EmailType](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/emailtype.md) object | The format to use when sending an email to a subscriber. Valid values include: | | `GlobalUnsubscribeCategory` | [GlobalUnsubscribeCategory](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/globalunsubscribecategory.md) object | Indicates how the application handles a globally unsubscribed subscriber. | | `ID` | Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. | | `Lists` | Array of [SubscriberList](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/subscriberlist.md) objects | Defines lists a subscriber resides on. | | `Locale` | [Locale](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/locale.md) object | Contains the locale information for an Account. If no location is set, Locale defaults to en-US. | | `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 | Not used. | | `Owner` | [Owner](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/owner.md) object | 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 the client and stored by the system. These properties are accessible only via API. | | `PartnerType` | String | Defines partner associated with a subscriber. | | `PrimaryEmailAddress` | [EmailAddress](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/emailaddress.md) object | Indicates primary email address for a subscriber. | | `PrimarySMSAddress` | SMSAddress | Indicates primary SMS address for a subscriber. Used to create and update SMS Address for a given subscriber. | | `PrimarySMSPublicationStatus` | [SubscriberAddressStatus](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/subscriberaddressstatus.md) object | Indicates the subscriber's modality status. | | `Status` | [SubscriberStatus](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/subscriberstatus.md) object | Defines status of object. Status of an address. | | `SubscriberKey` | String | Identification of a specific subscriber. | | `SubscriberTypeDefinition` | [SubscriberTypeDefinition](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/subscribertypedefinition.md) object | Specifies if a subscriber resides in an integration, such as Salesforce or Microsoft Dynamics CRM. | | `UnsubscribedDate` | DateTime | Represents date subscriber unsubscribed from a list. | ## Related Items - [Supported Operations for Objects and Methods](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/supported_operations_for_objects_and_methods.md) - [Add Subscribers to a List](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/adding_subscribers_to_a_list.md) - [Add Subscribers to a Lock and Publish Account](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/adding_subscribers_to_a_lock_and_publish_account.md) - [Add Subscribers to an On-Your-Behalf Account](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/adding_subscribers_to_an_on_your_behalf_account.md) - [Create a Subscriber](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/creating_a_subscriber.md) - [Describe a Subscriber](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/describing_a_subscriber.md) - [Manage Enterprise 2.0 Accounts](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/managing_enterprise_20_accounts_with_the_web_services_api.md) - [Manage Subscribers On Lists](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/managing_subscribers_on_lists.md) - [Retrieve a Subscriber](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/retrieve_a_subscriber_via_the_web_service_api.md)