Delete a custom field value

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

• cURL

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

• Node

var request = require("request");

var options = { method: 'DELETE',
  url: 'https:///:account.api-us1.com/api/3/dealCustomFieldData/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/dealCustomFieldData/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/dealCustomFieldData/id");

xhr.send(data);

• Python

import requests

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

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

print(response.text)

 

200 OK

{
  "message": "DealCustomFieldData deleted."
}

404 Not Found

{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

PATH PARAMS

id                                                          REQUIRED

int32                                                    ID of the dealCustomFieldData to retrieve

 

To delete a custom deal field value, 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 that the deal belongs to. If the user does not have the permission to manage the pipeline, limited deal data are returned with only id, title, and isDisabled set to 1.