Use ClientID in Your Code

Use ClientID to control which account an object is associated with when using Marketing Cloud Engagement Enterprise, Enterprise 2.0, and Agency editions. To ensure the object is created in the right account, specify the client ID on all objects passed into the API.

When you provision an account through the API, you can set a PartnerKey for the account to identify it externally. Reference the PartnerKey in the ClientID object PartnerClientKey property. If you don’t associate PartnerKey with the account, use the ClientID objectID property with your account ID as the value.

Marketing Cloud Engagement maintains the PartnerClientKey property for legacy functionality and backwards compatibility. To avoid performance issues, don’t use this property in new code or integrations. Replace this property with ClientID whenever possible.

Sample .NET Code

These .NET code examples show how to use the ClientID in your code.

Authenticate to the SOAP API Using the Parent Account

1// Initialize the web service proxy
2PartnerAPIWse integrationFramework = new PartnerAPIWse();
3// Set the username/password.  This is using the Username token of WS-Security 1.0
4UsernameTokenProvider utp = new UsernameTokenProvider("username", "password");
5integrationFramework.SetClientCredential<UsernameToken>(utp.GetToken());
6// Declare the policy
7policy = new Policy(new UsernameOverTransportAssertion());
8integrationFramework.SetPolicy(policy);
9...

Create an Account with a Partner Key

1Account account = new Account();
2account.Name = "Account " + name;
3account.PartnerKey = "12345"; // partner key eases the management of sub-accounts
4account.FromName = "Account " + name;

Create a ClientID

1ClientID clientId = new ClientID();
2// Option #1 - Use Account ID
3//clientId.ID = 12345;
4//clientId.IDSpecified = true;
5// Option #2 - Use the partner key you provided for the account
6clientId.PartnerClientKey = "12345";
7...

Create a List

1List list = new List();
2list.Client = clientID; // The owner of the list
3list.PartnerKey = "121245"; // Your identifier for the list
4list.ListName = "Campaign 1";
5list.Description = "Subscriber in Campaign 1";

Retrieve a List from a Specific Account

1ClientID rrclient = new ClientID();
2rrclient.ID = 12345;
3rrclient.IDSpecified = true;
4rr.Options.Client = rrclient;
5... // Retrive the list

1ClientID[] clients = new ClientID[1];
2clients[0] = new ClientID();
3clients[0].ID = 12345;
4clients[0].IDSpecified = true;
5rr.ClientIDs = clients;
6... // Retrive the list

SOAP Envelopes

Use ClientID in your SOAP calls differently, depending on the method. In each of these examples, notice the unique placement and usage of the Client property in the SOAP body.

ClientID for Create

1<CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI" xmlns:ns2="urn:fault.partner.exacttarget.com">
2   <Options>
3      <RequestType>Asynchronous</RequestType>
4   </Options>
5   <Objects xsi:type="DataFolder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
6      <Client>
7         <ID>1234567</ID>
8      </Client>
9      <ModifiedDate xsi:nil="true"/>
10      <ObjectID xsi:nil="true"/>
11      <CustomerKey>LandingPageExample V2</CustomerKey>
12      <ParentFolder>
13         <ModifiedDate xsi:nil="true"/>
14         <ID>1651427</ID>
15         <ObjectID xsi:nil="true"/>
16      </ParentFolder>
17      <Name>testtest</Name>
18      <Description>Words</Description>
19      <ContentType>content</ContentType>
20      <IsActive>true</IsActive>
21      <IsEditable>true</IsEditable>
22      <AllowChildren>true</AllowChildren>
23   </Objects>
24</CreateRequest>

ClientID for Delete

1<DeleteRequest xmlns="http://exacttarget.com/wsdl/partnerAPI">
2   <Objects xsi:type="DataExtensionObject">
3      <Client>
4         <ID>1234567</ID>
5      </Client>
6      <CustomerKey>DE_SNKRS_REL_12345-YYY_1WEEK</CustomerKey>
7      <Keys>
8         <Key>
9            <Name>SubscriberKey</Name>
10            <Value>TRANS_example1@bh.exacttarget.com</Value>
11         </Key>
12      </Keys>
13   </Objects>
14</DeleteRequest>

ClientID for Perform

1<PerformRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
2   <Action>start</Action>
3   <Definitions>
4      <Definition xsi:type="Automation">
5         <Client>
6            <ID>1234567</ID>
7         </Client>
8         <ObjectID>d3f5e492-f1a9-47be-a510-15b0d8de65d3</ObjectID>
9      </Definition>
10   </Definitions>
11</PerformRequestMsg>

ClientID for Retrieve

1<RetrieveRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
2   <RetrieveRequest>
3      <ClientIDs>
4         <ClientID>1234567</ClientID>
5      </ClientIDs>
6      <ObjectType>DataFolder</ObjectType>
7      <Properties>Client.ID</Properties>
8      <Properties>CreatedDate</Properties>
9      <Properties>CustomerKey</Properties>
10      <Properties>Description</Properties>
11      <Properties>ID</Properties>
12      <Properties>IsActive</Properties>
13      <Properties>Name</Properties>
14      <Properties>ObjectID</Properties>
15      <Filter xsi:type="SimpleFilterPart">
16         <Property>ID</Property>
17         <SimpleOperator>equals</SimpleOperator>
18         <Value>69236</Value>
19      </Filter>
20      <QueryAllAccounts>false</QueryAllAccounts>
21   </RetrieveRequest>
22</RetrieveRequestMsg>

ClientID for Update

1<UpdateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI">
2   <Options/>
3   <Objects xsi:type="DataExtension">
4      <Client>
5         <ID>1234567</ID>
6      </Client>
7      <partnerkey xsi:nil="true"/>
8      <modifieddate xsi:nil="true"/>
9      <objectid xsi:nil="true"/>
10      <CustomerKey>TSD_BASE_TEMPLATE</CustomerKey>
11      <Fields>
12         <Field>
13            <partnerkey xsi:nil="true"/>
14            <modifieddate xsi:nil="true"/>
15            <Name>cp_code</Name>
16            <ObjectID>e83ef05e-5487-4252-bb0c-48c0a632db0b</ObjectID>
17            <MaxLength>190</MaxLength>
18         </Field>
19      </Fields>
20   </Objects>
21</UpdateRequest>