This is an older version of the Campaign Monitor API. We strongly encourage you to quit livin' in the past and use the shiny new RESTful version with lots of new functionality. You won't regret it.

API › Client.GetDetail

Client.GetDetail

Gets the complete account and billing details for a particular client.

Parameters and required information

Here’s a list of all the parameters you’ll need to pass to the Client.GetDetail method. All of the parameters are required.

ApiKey
Your API application key. See here for more details.

ClientID
The ID of the client whose details are being requested. See here for more details.

Return Codes

Success

A successful call to Client.GetDetail will return a ClientDetail object, comprised of ClientBasicDetails and ClientAccessAndBilling.

ClientBasicDetails

A ClientBasicDetails object is comprised of those parameters necessary for calling Client.UpdateBasics

ClientID
The clientID of this client, included for completeness

CompanyName
The client’s company name

ContactName
The name of the contact person for this client

EmailAddress
The email address by which this client will be contacted

Country
Country location of the client

Timezone
Client timezone, necessary for accurate reporting

ClientAccessAndBilling

A ClientAccessAndBilling object is comprised of those parameters necessary for calling Client.UpdateAccessAndBilling

AccessLevel
An integer describing the client’s ability to access different areas of the application. Influences the significance and requirements of the following parameters. Click here for a full description of available levels.

Username
Client login username. Left empty if AccessLevel is set to 0.

Password
This previously contained the client login password, however this has been now been deprecated. This field will now contain the value “Deprecated” to reflect this change.

BillingType
Client billing type, left blank unless AccessLevel is set to allow the client to create and send campaigns

Currency
Billing currency for this client, only required if BillingType is set to either ClientPaysAtStandardRate or ClientPaysWithMarkup. See full details.

DeliveryFee
Flat rate delivery fee to be charged to the client for each campaign sent, expressed in the chosen currency’s major unit, but without the currency symbol (for example, “6.5” means “$6.50” if USD is used). Left empty unless BillingType is set to ClientPaysWithMarkup, otherwise the standard rates will be used.

CostPerRecipient
Additional cost added to the campaign for each email address the campaign is sent to, expressed in the chosen currency’s minor unit (for example, “1.5” means 1.5 cents per email address if USD is used). Left empty unless BillingType is set to ClientPaysWithMarkup, otherwise the standard rates will be used.

DesignAndSpamTestFee
Expressed in the chosen currency’s major unit (for example, sending “10” means “$10” if USD is used). Left empty unless BillingType is set to ClientPaysWithMarkup and client has access to design and spam tests, otherwise the standard rate will be used (identical to the standard DeliveryFee for that currency).

Error

100: Invalid API Key
The API key pass was not valid or has expired.

102: Invalid ClientID
The ClientID value passed in was not valid.

SOAP 1.1

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: api.createsend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.createsend.com/api/Client.GetDetail"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Client.GetDetail xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
    </Client.GetDetail >
  </soap:Body>
</soap:Envelope>
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Client.GetDetailResponse xmlns="http://api.createsend.com/api/">
      <Client.GetDetailResult xsi:type="ClientDetail">
        <BasicDetails>
          <ClientID>string</ClientID>
          <CompanyName>string</CompanyName>
          <ContactName>string</ContactName>
          <EmailAddress>string</EmailAddress>
          <Country>string</Country>
          <TimeZone>string</TimeZone>
        </BasicDetails>
        <AccessAndBilling>
          <AccessLevel>int</AccessLevel>
          <Username>string</Username>
          <Password>string</Password>
          <BillingType>string</BillingType>
          <Currency>string</Currency>
          <DeliveryFee>string</DeliveryFee>
          <CostPerRecipient>string</CostPerRecipient>
          <DesignAndSpamTestFee>string</DesignAndSpamTestFee>
        </AccessAndBilling>
      </Client.GetDetailResult>
    </Client.GetDetailResponse>
  </soap:Body>
</soap:Envelope>pre>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/api.asmx/Client.GetDetail?ApiKey=string&ClientID=string HTTP/1.1
Host: api.createsend.com
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<anyType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xsi:type="ClientDetail" xmlns="http://api.createsend.com/api/">
  <BasicDetails>
    <ClientID>string</ClientID>
    <CompanyName>string</CompanyName>
    <ContactName>string</ContactName>
    <EmailAddress>string</EmailAddress>
    <Country>string</Country>
    <TimeZone>string</TimeZone>
  </BasicDetails>
  <AccessAndBilling>
    <AccessLevel>int</AccessLevel>
    <Username>string</Username>
    <Password>string</Password>
    <BillingType>string</BillingType>
    <Currency>string</Currency>
    <DeliveryFee>string</DeliveryFee>
    <CostPerRecipient>string</CostPerRecipient>
    <DesignAndSpamTestFee>string</DesignAndSpamTestFee>
  </AccessAndBilling>
</anyType>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx/Client.GetDetail HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ClientID=string
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<anyType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xsi:type="ClientDetail" xmlns="http://api.createsend.com/api/">
  <BasicDetails>
    <ClientID>string</ClientID>
    <CompanyName>string</CompanyName>
    <ContactName>string</ContactName>
    <EmailAddress>string</EmailAddress>
    <Country>string</Country>
    <TimeZone>string</TimeZone>
  </BasicDetails>
  <AccessAndBilling>
    <AccessLevel>int</AccessLevel>
    <Username>string</Username>
    <Password>string</Password>
    <BillingType>string</BillingType>
    <Currency>string</Currency>
    <DeliveryFee>string</DeliveryFee>
    <CostPerRecipient>string</CostPerRecipient>
    <DesignAndSpamTestFee>string</DesignAndSpamTestFee>
  </AccessAndBilling>
</anyType>