Account

Represents a Marketing Cloud Engagement account.

  • To create or update Account subscription data, you need the Administration | Account | Subscription permission.
  • To create or update Account private label data, you need the Administration | Account | Private Labels permission.
  • To create or update Account business rule data, you need the Administration | Account | Business Rules permission.
  • To create or update Account role data, you need the Administration | Business Units | Manage Roles permission.

If the authenticated user exists in a Reseller or Enterprise account and there are more subaccounts available, you can create an Account object. If the authenticated user is a Core account, you can retrieve object attributes.

Retrieve an account by its ID or PartnerKey. Use filters to further refine the results, if necessary.

For Embedded partners, use the PartnerKey property to associate an external identifier with the account. You can’t change the PartnerKey after the Account is created, so we recommend using CustomerKey instead.

NameData TypeDescription
AccountTypeAccountTypeEnumThe type of Marketing Cloud Engagement account.
AccountUsersArray of AccountUser objectsAn array of users associated with a specific account.
AddressStringThe street address associated with the account.
BrandIDIntThe brand tags associated with the account.
BusinessNameStringThe business name associated with an account.
BusinessRulesArray of BusinessRule objectsNot used.
ChildrenArray of AccountDataItem objectsAn array of AccountDataItem objects that represent child accounts of this account.
CityStringThe city associated with the account.
ClientClientID objectSpecifies the account ownership and context of an object.
CorrelationIDStringIdentifies correlation of objects across several requests.
CountryStringThe country associated with the account.
CreatedDateDateTimeThe date and time when the account was created.
CustomerIDLongNot used.
CustomerKeyStringA user-supplied unique identifier for the account.
DBIDIntNot used.
DeletedDateDateTimeThe date and time of an account’s deletion. The value of this property must be set before the account can be deleted.
EditionIDIntSpecifies the product edition of the account.
EmailStringThe email address associated with the account.
FaxStringThe fax number associated with the account.
FromNameStringSpecifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
InheritAddressBooleanSpecifies that an Enterprise 2.0 business unit inherits the address from the parent business unit.
IsActiveIntSpecifies whether the account is active.
IsTestAccountBooleanSpecifies whether an account is a test account.
IsTrialAccountBooleanNot used.
LanguageLocaleLocale objectDefines the language preferences associated with the account.
LocaleLocale objectContains the locale information for the account. The default value is en-US.
ModifiedDateDateTimeThe date and time when the account was last modified.
NameStringThe name of the account.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringNot used.
OrgIDIntParent account ID for On-Your-Behalf or Lock-and-Publish accounts.
OwnerOwner objectDescribes the ownership the account in an on-your-behalf account.
ParentAccountAccount objectProvides information about the parent account.
ParentIDIntThe ID of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units.
ParentNameStringThe name of the Parent account.
PartnerKeyStringA unique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PhoneStringThe phone number associated with the account.
PrivateLabelIDIntThe private label ID for the account.
PrivateLabelsArray of PrivateLabel objectsSpecifies UI modifications to use on child accounts.
ReportingParentIDIntNot used.
RolesArray of Role objectsCollection of roles defined for an account.
StateStringThe state or region associated with the account.
SubscriptionSubscription objectContains information about the subscriptions that apply to the account.
TimeZoneTimeZone objectContains time zone information for the account. For Create and Update calls, this property defines the time zone for an Account object. In 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.
ZipStringThe ZIP code associated with the account.