Create deal


Update standard attributes for existing deal with HTTP PUT request.

POST

/deals-by-id/

Attributes
Type
Description
person
integer
Unique ID provided in user model
person_user_id
string
Custom ID provided by client in user model
company
integer
Unique ID provided in company model
company_custom_id
string
Custom ID provided by client in company model
products
array of integers
Unique ID provided in product model
products_custom_id
array of strings
Custom ID provided by client in product model
assigned_to
integer
Unique ID provided in agent group model
loss_reason
integer
Get all loss reasons here
loss_reason_description
string
Describe here why you lost deal
currency
string
Choose currency of value provided in deal
expected_close_date
string
Provide date in format YYYY:MM:DD
status
integer
Learn more about this attribute here
scope
integer
Learn more about this attribute here
activities_status
integer
Learn more about this attribute here
...
...
...
curl -X POST -H "Authorization: Token <your_64_char_api_key>" -H "Content-Type: application/json" -d '{
  "name": "Created name",
  "description": "updated description",
}' "https://<your_app_subdomain>.user.com/api/public/deals-by-id/"

Response

{
    "id": 3300,
    "name": "Updated deal name",
    "value": "525.00",
    "currency": "USD",
    "custom_id": "<:deal_id>",
    "stage": 25898,
    "pipeline": 4338,
    "assigned_to": null,
    "restricted_to": null,
    "agent": 5567,
    "products": [1, 2],
    "products_custom_id": ["custom_1", "custom_2"],
    "company": 123,
    "company_custom_id": "my_id",
    "person": 22266722,
    "person_id": "my_person_id",
    "status": "1",
    "scope": "2",
    "created_by": 5567,
    "created_at": "2017-06-27T14:51:04.331287Z",
    "updated_at": "2017-07-10T12:01:58.617681Z",
    "activities_status": "3",
    "activities_status_updated_at": "2017-07-10T12:01:58.617406Z",
    "expected_close_date": null
}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://<your_app_subdomain>.user.com/api/public/deals-by-id/",
  "method": "POST",
  "headers": {
    "authorization": "Token <your_64_char_api_key>",
    "content-type": "application/json"
  },
  "data": {
        "id": 1666,
    "name": "Created name",
    "description": "updated description",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var data = JSON.stringify({
  "name": "Created name",
  "description": "updated description",
});

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

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

xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/deals-by-id/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://<your_app_subdomain>.user.com/api/public/deals-by-id/',
  headers: {
    'content-type': 'application/json',
    authorization: 'Token <your_64_char_api_key>'
  },
  form: {
        "id": 1666,
    "name": "Created name",
    "description": "updated description",
  }
};

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

  console.log(body);
});
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/deals-by-id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"name\": \"Created name\",\n  \"description\": \"updated description\"\n \n}",
  CURLOPT_HTTPHEADER => array(
    "authorization: Token <your_64_char_api_key>",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
import requests

url = "https://<your_app_subdomain>.user.com/api/public/deals-by-id/"

payload = "{\n  \"name\": \"Created name\",\n  \"description\": \"updated description\"\n  \n}"
headers = {
    'authorization': "Token <your_64_char_api_key>",
    'content-type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)