REST Email Marketing API Documentation

Segments — delete

Remove an existing segment.

HTTP VERB

Delete

URL

/API/Rest/Segments

ARGUMENTS

name


Required permission

CreateEditFixedSegment, CreateEditWizardSegment, CreateEditSpSegment, or CreateEditAdHocSegment, as appropriate

ERRORS

No Permission
Invalid segment name
Too many API calls
Database error
Unknown error

RETURNS

Segment deleted



EXAMPLE

Remove a segment.


string url = "http://example.com/api/rest/Segments/?accountName=acme&login=ApiUser&name=xmas2016";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "sdjks8fsdysgd7");
	request.Method = "DELETE";
	request.ContentLength = 0;
	using (System.Net.WebResponse response = request.GetResponse())
		using (Stream responseStream = response.GetResponseStream())
			using (StreamReader reader = new StreamReader(responseStream, Encoding.UTF8))
				System.Console.WriteLine(reader.ReadToEnd());
}
catch (System.Net.WebException ex)
{
	System.Diagnostics.Debug.Fail(ex.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://example.com/api/rest/Segments/?accountName=acme &login=ApiUser &name=xmas2016'
response = RestClient.delete(url, {:Password => "fhdf6df5fdy"})
puts response						
						
import requests
url = "http://www.example.com/api/rest/Segments/?accountName=acme&login=ApiUser&name=xmas2016";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.delete(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X delete -H "password: sfhdf6df5fdy" "http://www.example.com/api/rest/Segments/?accountName=acme &login=ApiUser &name=xmas2016

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.