BusinessUnit
The BusinessUnit object represents a unit within an Enterprise or Enterprise 2.0 account. To create or update business unit roles, you must have the Administration | Business Units | Manage Roles permission. To create or update a BusinessUnit subscriber filter, you must have the Administration | Business Units | Define Subscriber Filter permission.
| Name | Data Type | Description |
|---|---|---|
AccountType | AccountTypeEnum | Type of Marketing Cloud Engagement account. Valid values include:
|
AccountUsers | Array of AccountUser objects | An array of users associated with a specific account. |
Address | String | The physical mailing address required at the bottom of all email messages contains the information described by this property (no P.O. Boxes). The address used to communicate with a Person. |
BrandID | Int | Specifies brand tags to use on an account. |
BusinessName | String | Business name of an account's owner. |
BusinessRules | Array of BusinessRule objects | Not used. |
Children | Array of AccountDataItem objects | An array of AccountDataItem objects that represent child accounts of this account. |
City | String | City of an account's owner to be displayedin thephysical mailing address required at the bottom of all email messages. |
Client | ClientID object | Specifies the account ownership and context of an object. |
CorrelationID | String | Identifies correlation of objects across several requests. |
Country | String | Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages. |
CreatedDate | DateTime | The date and time when the object was created. |
CustomerID | Long | Not used. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
DBID | Int | Not used. |
DefaultHomePage | LandingPage | Defines default landing page for business unit to use as home page. |
DefaultSendClassification | SendClassification object | Defines default send classification for all sends from a specific business unit. |
DeletedDate | DateTime | Read-only date and time of an account's deletion (the value of this property must be set before the account can be deleted). |
Description | String | Describes and provides information regarding the object. |
EditionID | Int | Specifies the product edition of the account. Valid values include:
|
Email | String | Default email address for object. Indicates if subscriber information can be used for email sends. |
Fax | String | Fax number of the account's owner. |
FromName | String | Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions. |
ID | Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
InheritAddress | Boolean | Specifies that an Enterprise 2.0 business unit inherits the address from the parent business unit. |
IsActive | Int | Specifies whether the object is active. |
IsTestAccount | Boolean | Specifies whether an account is a "Test" account. |
IsTrialAccount | Boolean | Not used. |
LanguageLocale | Locale object | Defines language preferences associated with a account, business unit, or user. |
Locale | Locale object | Contains the locale information for an Account. If no location is set, Locale defaults to en-US. |
MasterUnsubscribeBehavior | UnsubscribeBehaviorEnum | Defines how master unsubscription requests are handled for a business unit.Valid values include ENTIRE_ENTERPRISE or BUSINESS_UNIT_ONLY. |
ModifiedDate | DateTime | The date and time when the object was last modified. |
Name | String | Name of the object or property. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
ObjectState | String | Not used. |
OrgID | Int | Parent account ID for On-Your-Behalf or Lock-and-Publish accounts. |
Owner | Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
ParentAccount | Account object | Provides more information regarding the parent account. |
ParentID | Int | Specifies thethe ID number of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units. |
ParentName | String | Specifies the name of the Parent account. |
PartnerKey | String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties | Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
Phone | String | Specifies a phone number. Specifies the phone number of the account owner. Specifies the Phone data type. |
PrivateLabelID | Int | Specifies the private label for an account. |
PrivateLabels | Array of PrivateLabel objects | Specifies UI modifications to use on child accounts. |
ReportingParentID | Int | Not used. |
Roles | Array of Role objects | Collection of roles defined for an account. |
State | String | Specifies the geographical state of the account's owner. The physical mailing address required at the bottom of all email messages contains the information described by this property. |
SubscriberFilter | FilterPart object | Defines filter used to assign subscribers to a specific business unit within an Enterprise or Enterprise 2.0 structure. |
Subscription | Subscription object | Not used. |
TimeZone | TimeZone object | Contains time zone information for an Account. For Create and Update calls, this property defines the time zone for an Account object. On a Retrieve call, TimeZone indicates which time zone is in effect for the Account object in question. Without a specific time zone, the Account defaults to Central Standard Time. |
Zip | String | Specifies the zip code of the account's owner. The physical mailing address required at the bottom of all email messages contains the information described by this property. |