api
Click here for a complete list of operations.
List.CreateCustomField
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api/api.asmx HTTP/1.1
Host: uuapi-int.createsend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.createsend.com/api/List.CreateCustomField"
<?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>
<List.CreateCustomField xmlns="http://api.createsend.com/api/">
<ApiKey>string</ApiKey>
<ListID>string</ListID>
<FieldName>string</FieldName>
<DataType>string</DataType>
<Options>string</Options>
</List.CreateCustomField>
</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>
<List.CreateCustomFieldResponse xmlns="http://api.createsend.com/api/">
<List.CreateCustomFieldResult>
<Code>long</Code>
<Message>string</Message>
</List.CreateCustomFieldResult>
</List.CreateCustomFieldResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api/api.asmx HTTP/1.1
Host: uuapi-int.createsend.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<List.CreateCustomField xmlns="http://api.createsend.com/api/">
<ApiKey>string</ApiKey>
<ListID>string</ListID>
<FieldName>string</FieldName>
<DataType>string</DataType>
<Options>string</Options>
</List.CreateCustomField>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<List.CreateCustomFieldResponse xmlns="http://api.createsend.com/api/">
<List.CreateCustomFieldResult>
<Code>long</Code>
<Message>string</Message>
</List.CreateCustomFieldResult>
</List.CreateCustomFieldResponse>
</soap12:Body>
</soap12: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/List.CreateCustomField?ApiKey=string&ListID=string&FieldName=string&DataType=string&Options=string HTTP/1.1 Host: uuapi-int.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>long</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/List.CreateCustomField HTTP/1.1 Host: uuapi-int.createsend.com Content-Type: application/x-www-form-urlencoded Content-Length: length ApiKey=string&ListID=string&FieldName=string&DataType=string&Options=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>long</Code> <Message>string</Message> </Result>