(Click the banner to go to the related Docs.Code.ExactTarget.com page.)
Definition
An ExactTarget account.
Properties
This object has following properties.
| Name | Data Type | Description |
| AccountType | AccountTypeEnum | Type of ExactTarget account |
| 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[] | Reserved for future use. |
| 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 displayed in the physical 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 | Reserved for future use. |
| CustomerKey | xsd:string | User-supplied unique identifier for an object within an object type (corresponds to the external key assigned to an object in the user interface). |
| DBID | xsd:int | Reserved for future use. |
| 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). |
| EditionID | xsd:int | Specifies the product edition of the account |
| Email | 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 legacy identifier for an object. Not supported on all objects. Some objects use the ObjectID property as the ExactTarget unique ID. |
| InheritAddress | xsd:boolean | Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit |
| IsActive | xsd:int | Specifies whether or not the object is active |
| IsTestAccount | xsd:boolean | Specifies whether or not an account is a "Test" account |
| IsTrialAccount | xsd:boolean | Reserved for future use. |
| 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 (English in United States). |
| 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 | Reserved for future use. |
| 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 additional information regarding the parent account. |
| ParentID | xsd:int | Specifies 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. |
| ParentName | xsd:string | Specifies the name of the Parent account |
| PartnerKey | xsd:string | Unique identifier provided by partner for an object, accessible only via API. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by client and stored by system - only accessible 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 | Reserved for future use |
| 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. |
| Subscription | Subscription | Reserved for future use. |
| 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. |
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.
| Name | Description |
|---|
| Create | Creates an individual object or a batch of objects. |
| Delete | Deletes an individual object or a batch of objects. |
| Retrieve | Retrieves an individual object or a batch of objects. |
| Update | Updates 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: