Delete a pipeline

DELETE  https://:account.api-us1.com/api/3/dealGroups/id

• cURL

curl --request DELETE \
  --url https:///:account.api-us1.com/api/3/dealGroups/id

• Node

var request = require("request");

var options = { method: 'DELETE',
  url: 'https:///:account.api-us1.com/api/3/dealGroups/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/dealGroups/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https:///:account.api-us1.com/api/3/dealGroups/id");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/dealGroups/id"

response = requests.request("DELETE", url)

print(response.text)

 

403 deals exist

{
  "message": "Unable to delete dealGroup. You have deals belonging to dealGroup."
}

403 stages exist

{
  "message": "Unable to delete dealGroup. You have stages belonging to dealGroup."
}

PATH PARAMS

id                                  REQUIRED

int32                             Pipeline's id

 

To delete a pipeline, the following permissions are required.

• Deal permission: the user should have permission to manage deals.
• Pipeline-specific permission: the user should have permission to manage the pipeline.
• Pipeline delete permission: the user should have permission to delete a pipeline.

If trying to delete a pipeline that still has existing deals and stages associated with it, the DELETE request is rejected and an error message is returned in the response.