Salesforce Docs Portal

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.

Using the Account Object

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.

Retrieving an Account Object

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

Embedded Partner Usage

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.

Properties

Name Data Type Description
AccountType AccountTypeEnum The type of Marketing Cloud Engagement account.
AccountUsers Array of AccountUser objects An array of users associated with a specific account.
Address String The street address associated with the account.
BrandID Int The brand tags associated with the account.
BusinessName String The business name associated with an account.
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 The city associated with the account.
Client ClientID object Specifies the account ownership and context of an object.
CorrelationID String Identifies correlation of objects across several requests.
Country String The country associated with the account.
CreatedDate DateTime The date and time when the account was created.
CustomerID Long Not used.
CustomerKey String A user-supplied unique identifier for the account.
DBID Int Not used.
DeletedDate DateTime The date and time of an account’s deletion. The value of this property must be set before the account can be deleted.
EditionID Int Specifies the product edition of the account.
Email String The email address associated with the account.
Fax String The fax number associated with the account.
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 account is active.
IsTestAccount Boolean Specifies whether an account is a test account.
IsTrialAccount Boolean Not used.
LanguageLocale Locale object Defines the language preferences associated with the account.
Locale Locale object Contains the locale information for the account. The default value is en-US.
ModifiedDate DateTime The date and time when the account was last modified.
Name String The name of the account.
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 the ownership the account in an on-your-behalf account.
ParentAccount Account object Provides information about the parent account.
ParentID Int The ID of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units.
ParentName String The name of the Parent account.
PartnerKey String A 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 The phone number associated with the account.
PrivateLabelID Int The private label ID for the 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 The state or region associated with the account.
Subscription Subscription object Contains information about the subscriptions that apply to the account.
TimeZone TimeZone object Contains 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.
Zip String The ZIP code associated with the account.

Related Items