Delete data field

The DeleteDataField method can be used to delete a data field within your dotMailer account.

Guidance Notes

You cannot delete a reserved datafield (FIRSTNAME, LASTNAME, ADDRESS, POSTCODE, GENDER) or any that are currently in use elsewhere in the system. This method will return an API dependencies object. This will specify the type of dependency and the ID of the dependency.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
fieldname	string	This is the name of the data field you want to delete.	required

Return values

None.

Error responses

ERROR_DATAFIELD_NOTFOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/DeleteDataField"

Example of use in C# .NET

/// <summary>
/// This method is used to delete data fields within your dotMailer account.
/// </summary>
public void DeleteDataField()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const string dataFieldName = "DTTest";
 
    Console.WriteLine("DeleteDataField");
    Console.WriteLine("---------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // delete the data field via the web service
        com.apiconnector.APIDependencyResult result = api.DeleteDataField(username, password, dataFieldName);
 
        // did we get anything back from the web service
        if (result != null)
        {
            // did we actually delete the data field
            if (result.Result)
            {
                Console.WriteLine("Data field {0} deleted", dataFieldName);
            }
        }
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/DeleteDataField"
<?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>
    <DeleteDataField xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <fieldname>string</fieldname>
    </DeleteDataField>
  </soap:Body>
</soap:Envelope>

Sample response

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>
    <DeleteDataFieldResponse xmlns="http://apiconnector.com">
      <DeleteDataFieldResult>
        <Dependencies>
          <APIDependency>
            <Type>Campaign or Survey or MicrositePage or DynamicContent or ContactLabel or SurveyQuestion or AddressBook or DynamicContentRule or CampaignLink or CampaignTemplate</Type>
            <ObjectID>int</ObjectID>
          </APIDependency>
          <APIDependency>
            <Type>Campaign or Survey or MicrositePage or DynamicContent or ContactLabel or SurveyQuestion or AddressBook or DynamicContentRule or CampaignLink or CampaignTemplate</Type>
            <ObjectID>int</ObjectID>
          </APIDependency>
        </Dependencies>
        <Result>boolean</Result>
      </DeleteDataFieldResult>
    </DeleteDataFieldResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates