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.UpdateBasics

Client.UpdateBasics

Updates the basic details of an existing client.

Parameters and required information

Here’s a list of all the parameters you’ll need to pass to the Client.UpdateBasics method. All of the parameters are required. If you wish to change only some details, the others must be included as they currently are. Please note that the client’s existing access and billing details will remain unchanged by a call to Client.UpdateBasics.

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

ClientID
The appropriate clientID. See here for more details.

CompanyName
The client company name.

ContactName
The personal name of the principle contact for this client.

EmailAddress
An email address to which this client will be sent application-related emails.

Country
This client’s country.

Timezone
Client timezone for tracking and reporting data. Valid timezone strings are obtainable by means of the API procedure User.GetTimezones.

Return Codes

Success

0: Success
Basic client details were updated successfully

Error

1: Invalid Email
Email address is missing or incorrectly formatted

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

150: Email Taken
Chosen email address is already being used

152: Invalid Timezone
Timezone string is not in the correct format. Call User.GetTimezones for a full list.

154: Empty Company Name
Company name cannot be empty

155: Empty Contact Name
Contact name cannot be empty

157: Invalid Country
Country string is either empty or invalid

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.UpdateBasics"

<?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.UpdateBasics xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
      <CompanyName>string</CompanyName>
      <ContactName>string</ContactName>
      <EmailAddress>string</EmailAddress>
      <Country>string</Country>
      <Timezone>string</Timezone>
    </Client.UpdateBasics>
  </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.UpdateBasicsResponse xmlns="http://api.createsend.com/api/">
      <Client.UpdateBasicsResult>
        <Code>int</Code>
        <Message>string</Message>
      </Client.UpdateBasicsResult>
    </Client.UpdateBasicsResponse >
  </soap:Body>
</soap:Envelope>

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.UpdateBasics?ApiKey=string&ClientID=string&CompanyName=string&ContactName=string&EmailAddress=string&Country=string&Timezone=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"?>
<Result xmlns="http://api.createsend.com/api/">
  <Code>int</Code>
  <Message>string</Message>
</Result>

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.UpdateBasics HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<Result xmlns="http://api.createsend.com/api/">
  <Code>int</Code>
  <Message>string</Message>
</Result>