BusinessUnit
The BusinessUnit
object represents a unit within a larger 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 | AccountUser[] | An array of users associated with a specific account. |
Address | xsd: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 | xsd:int | Specifies brand tags to use on an account |
BusinessName | xsd:string | Business name of an account's owner |
BusinessRules | BusinessRule[] | Not used. |
Children | AccountDataItem[] | An array of AccountDataItem objects that represent child accounts of this account. |
City | xsd:string | City of an account's owner to be displayedin thephysical mailing address required at the bottom of all email messages |
Client | ClientID | Specifies the account ownership and context of an object. |
CorrelationID | xsd:string | Identifies correlation of objects across several requests. |
Country | xsd:string | Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages |
CreatedDate | xsd:dateTime | Read-only date and time of the object's creation. |
CustomerID | xsd:long | Not used. |
CustomerKey | xsd:string | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
DBID | xsd:int | Not used. |
DefaultHomePage | LandingPage | Defines default landing page for business unit to use as home page. |
DefaultSendClassification | SendClassification | Defines default send classification for all sends from a specific business unit. |
DeletedDate | xsd: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 | xsd:string | Describes and provides information regarding the object. |
EditionID | xsd:int | Specifies the product edition of the account. Valid values include:
|
xsd:string | Default email address for object. Indicates if subscriber information can be used for email sends. | |
Fax | xsd:string | Fax number of the account's owner |
FromName | xsd:string | Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions. |
ID | xsd:int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
InheritAddress | xsd:boolean | Specifies that an Enterprise 2.0 business unit inherits the address from the parent business unit. |
IsActive | xsd:int | Specifies whether the object is active |
IsTestAccount | xsd:boolean | Specifies whether an account is a "Test" account |
IsTrialAccount | xsd:boolean | Not used. |
LanguageLocale | Locale | Defines language preferences associated with a account, business unit, or user. |
Locale | Locale | 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 | Nullable`1 | Indicates the last time object information was modified. |
Name | xsd:string | Name of the object or property. |
ObjectID | xsd:string | System-controlled, read-only text string identifier for object. |
ObjectState | xsd:string | Not used. |
OrgID | xsd:int | Parent account ID for On-Your-Behalf or Lock-and-Publish accounts |
Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
ParentAccount | Account | Provides more information regarding the parent account. |
ParentID | xsd: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 | xsd:string | Specifies the name of the Parent account |
PartnerKey | xsd:string | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties | APIProperty[] | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
Phone | xsd:string | Specifies a phone number. Specifies the phone number of the account owner. Specifies the Phone data type |
PrivateLabelID | xsd:int | Specifies the private label for an account |
PrivateLabels | PrivateLabel[] | Specifies UI modifications to use on child accounts |
ReportingParentID | xsd:int | Not used. |
Roles | Role[] | Collection of roles defined for an account. |
State | xsd: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 | Defines filter used to assign subscribers to a specific business unit within an Enterprise or Enterprise 2.0 structure. |
Subscription | Subscription | Not used. |
TimeZone | TimeZone | 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 | xsd: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. |