Account

From $1

    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    Definition

    An ExactTarget account.

    Properties

    This object has following properties.

    NameData TypeDescription
    AccountTypeAccountTypeEnumType of ExactTarget account
    AccountUsersAccountUser[]An array of users associated with a specific account.
    Addressxsd:stringThe 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.
    BrandIDxsd:intSpecifies brand tags to use on an account
    BusinessNamexsd:stringBusiness name of an account's owner
    BusinessRulesBusinessRule[]Reserved for future use.
    ChildrenAccountDataItem[]An array of AccountDataItem objects that represent child accounts of this account.
    Cityxsd:stringCity of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages
    ClientClientIDSpecifies the account ownership and context of an object.
    CorrelationIDxsd:stringIdentifies correlation of objects across several requests.
    Countryxsd:stringCountry of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages
    CreatedDatexsd:dateTimeRead-only date and time of the object's creation.
    CustomerIDxsd:longReserved for future use.
    CustomerKeyxsd:stringUser-supplied unique identifier for an object within an object type (corresponds to the external key assigned to an object in the user interface).
    DBIDxsd:intReserved for future use.
    DeletedDatexsd:dateTimeRead-only date and time of an account's deletion (the value of this property must be set before the account can be deleted).
    EditionIDxsd:intSpecifies the product edition of the account
    Emailxsd:stringDefault email address for object. Indicates if subscriber information can be used for email sends.
    Faxxsd:stringFax number of the account's owner
    FromNamexsd:stringSpecifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
    IDxsd:intRead-only legacy identifier for an object. Not supported on all objects. Some objects use the ObjectID property as the ExactTarget unique ID.
    InheritAddressxsd:booleanSpecifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit
    IsActivexsd:intSpecifies whether or not the object is active
    IsTestAccountxsd:booleanSpecifies whether or not an account is a "Test" account
    IsTrialAccountxsd:booleanReserved for future use.
    LanguageLocaleLocaleDefines language preferences associated with a account, business unit, or user.
    LocaleLocaleContains the locale information for an Account. If no location is set, Locale defaults to en-US (English in United States).
    ModifiedDateNullable`1Indicates the last time object information was modified.
    Namexsd:stringName of the object or property.
    ObjectIDxsd:stringSystem-controlled, read-only text string identifier for object.
    ObjectStatexsd:stringReserved for future use.
    OrgIDxsd:intParent account ID for On-Your-Behalf or Lock-and-Publish accounts
    OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
    ParentAccountAccountProvides additional information regarding the parent account.
    ParentIDxsd:intSpecifies the the ID number of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units.
    ParentNamexsd:stringSpecifies the name of the Parent account
    PartnerKeyxsd:stringUnique identifier provided by partner for an object, accessible only via API.
    PartnerPropertiesAPIProperty[]A collection of metadata supplied by client and stored by system - only accessible via API.
    Phonexsd:stringSpecifies a phone number. Specifies the phone number of the account owner. Specifies the Phone data type
    PrivateLabelIDxsd:intSpecifies the private label for an account
    PrivateLabelsPrivateLabel[]Specifies UI modifications to use on child accounts
    ReportingParentIDxsd:intReserved for future use
    RolesRole[]Collection of roles defined for an account.
    Statexsd:stringSpecifies 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.
    SubscriptionSubscriptionReserved for future use.
    TimeZoneTimeZoneContains 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.
    Zipxsd:stringSpecifies 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.

    Description

    The Account object represents an ExactTarget account.

    Using the Account object

    If the authenticated user exists in an Reseller or Enterprise account and there are additional subaccounts available, an Account object can be created. If the authenticated user is a Core account, the Account object is usable for retrieving Account attributes.

    Retrieving an Account object

    An Account object can be retrieved by the unique properties ID or PartnerKey -- with additional properties being available for additional filtering.

    Embedded Partner Usage

    For Embedded partners, using the PartnerKey property will allow an external identifier to be associated with the account. PartnerKey cannot be updated on once the Account is created. Using the PartnerKey value on the ClientID object allows object ownership to be specified using an external identifier. For example, you can use the web service Create method to create an Email object in a child account. The Email object has a Client property that takes a ClientID object. The ClientID object has a PartnerClientKey property that once set to the value of the Account's PartnerKey property (instead of the ExactTarget generated ID property).

    Methods

    This object has the following methods.

    NameDescription
    CreateCreates an individual object or a batch of objects.
    DeleteDeletes an individual object or a batch of objects.
    RetrieveRetrieves an individual object or a batch of objects.
    UpdateUpdates an individual object or a batch of objects.

    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:55:30 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     


    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 17390 backwards:
       
    Tags: (Edit tags)
    • No tags
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin