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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Segments?accountName=acme&login=ApiUser&name=xmas2016";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Delete, url))
{
	request.Headers.Add("Password", "YOUR_PASSWORD");

	using (HttpResponseMessage response = await client.SendAsync(request))
	{
		response.EnsureSuccessStatusCode();
		Console.WriteLine(await response.Content.ReadAsStringAsync());
	}
}

# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'https://example.com/API/Rest/Segments?accountName=acme&login=ApiUser&name=xmas2016'
response = RestClient.delete(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests
url = "https://example.com/API/Rest/Segments?accountName=acme&login=ApiUser&name=xmas2016"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.delete(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

curl --request DELETE --header "Password: YOUR_PASSWORD" "https://example.com/API/Rest/Segments?accountName=acme&login=ApiUser&name=xmas2016"