Update a partnership deal
curl --request PATCH \
--url https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"stage_id": "<string>",
"label": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"custom_field_values": [
{
"custom_field_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"custom_field_value_id": "<string>"
}
],
"partner_custom_field_values": [
{
"custom_field_id": "<string>",
"lead_deal_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"custom_field_value_id": "<string>"
}
],
"tag": {
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>",
"added": true,
"removed": true
}
}
}
'import requests
url = "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
payload = { "fields": {
"stage_id": "<string>",
"label": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"custom_field_values": [
{
"custom_field_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
},
"custom_field_value_id": "<string>"
}
],
"partner_custom_field_values": [
{
"custom_field_id": "<string>",
"lead_deal_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
},
"custom_field_value_id": "<string>"
}
],
"tag": {
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>",
"added": True,
"removed": True
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fields: {
stage_id: '<string>',
label: '<string>',
expiration_date: '2023-11-07T05:31:56Z',
custom_field_values: [
{
custom_field_id: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
},
custom_field_value_id: '<string>'
}
],
partner_custom_field_values: [
{
custom_field_id: '<string>',
lead_deal_id: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
},
custom_field_value_id: '<string>'
}
],
tag: {
id: '<string>',
label: '<string>',
background_color: '<string>',
text_color: '<string>',
added: true,
removed: true
}
}
})
};
fetch('https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
'stage_id' => '<string>',
'label' => '<string>',
'expiration_date' => '2023-11-07T05:31:56Z',
'custom_field_values' => [
[
'custom_field_id' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
],
'custom_field_value_id' => '<string>'
]
],
'partner_custom_field_values' => [
[
'custom_field_id' => '<string>',
'lead_deal_id' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
],
'custom_field_value_id' => '<string>'
]
],
'tag' => [
'id' => '<string>',
'label' => '<string>',
'background_color' => '<string>',
'text_color' => '<string>',
'added' => true,
'removed' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
payload := strings.NewReader("{\n \"fields\": {\n \"stage_id\": \"<string>\",\n \"label\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"partner_custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"lead_deal_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"tag\": {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"added\": true,\n \"removed\": true\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"stage_id\": \"<string>\",\n \"label\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"partner_custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"lead_deal_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"tag\": {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"added\": true,\n \"removed\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": {\n \"stage_id\": \"<string>\",\n \"label\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"partner_custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"lead_deal_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"tag\": {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"added\": true,\n \"removed\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deal_value": 123,
"total_commission_occurrences": 123,
"lead_id": "<string>",
"total_commission_value": 123,
"stage_id": "<string>",
"label": "<string>",
"created_by_user_id": "<string>",
"expiration_date": "<string>",
"expired_at": "<string>",
"currency_code": "<string>",
"stage": {
"id": "<string>",
"label": "<string>",
"series": 123
},
"created_by_user_first_name": "<string>",
"created_by_user_last_name": "<string>",
"created_by_user_email": "<string>",
"created_by_user_profile_image_id": 123,
"created_by_user_profile_image_uuid": "<string>",
"lead_company_name": "<string>",
"lead_first_name": "<string>",
"lead_last_name": "<string>",
"lead_email": "<string>",
"lead_phone_number": "<string>",
"lead_campaign_id": "<string>",
"campaign_title": "<string>",
"partnership": {
"id": "<string>",
"uuid": "<string>",
"name": "<string>",
"logo_square_id": 123,
"logo_square_uuid": "<string>",
"partnership_distributors_id": "<string>",
"distributor_name": "<string>",
"distributor_logo_square_id": 123,
"distributor_logo_square_uuid": "<string>"
},
"tags": [
{
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>"
}
],
"assigned_users": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"assigned_contacts": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"custom_fields": [
{
"id": "<string>",
"label": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
],
"custom_field_value_id": "<string>"
}
],
"has_quote": true,
"has_products": true,
"has_live_calculators": true,
"id": "<string>",
"entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0
}
],
"spiff_entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0,
"recipient_user_id": "<string>",
"recipient_contact_id": "<string>",
"recipient_name": "<string>"
}
],
"total_spiff_value": 0,
"commission_overrides": [
{
"stage_label": "<string>",
"amount": 4503599627370495,
"currency_code": "<string>",
"note": "<string>",
"document": {
"uuid": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"mime_type": "<string>"
}
}
]
}Partner
Update a partnership deal
PATCH
/
partner
/
{partnershipId}
/
deals
/
{dealId}
Update a partnership deal
curl --request PATCH \
--url https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"stage_id": "<string>",
"label": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"custom_field_values": [
{
"custom_field_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"custom_field_value_id": "<string>"
}
],
"partner_custom_field_values": [
{
"custom_field_id": "<string>",
"lead_deal_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"custom_field_value_id": "<string>"
}
],
"tag": {
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>",
"added": true,
"removed": true
}
}
}
'import requests
url = "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
payload = { "fields": {
"stage_id": "<string>",
"label": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"custom_field_values": [
{
"custom_field_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
},
"custom_field_value_id": "<string>"
}
],
"partner_custom_field_values": [
{
"custom_field_id": "<string>",
"lead_deal_id": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
},
"custom_field_value_id": "<string>"
}
],
"tag": {
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>",
"added": True,
"removed": True
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fields: {
stage_id: '<string>',
label: '<string>',
expiration_date: '2023-11-07T05:31:56Z',
custom_field_values: [
{
custom_field_id: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
},
custom_field_value_id: '<string>'
}
],
partner_custom_field_values: [
{
custom_field_id: '<string>',
lead_deal_id: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
},
custom_field_value_id: '<string>'
}
],
tag: {
id: '<string>',
label: '<string>',
background_color: '<string>',
text_color: '<string>',
added: true,
removed: true
}
}
})
};
fetch('https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
'stage_id' => '<string>',
'label' => '<string>',
'expiration_date' => '2023-11-07T05:31:56Z',
'custom_field_values' => [
[
'custom_field_id' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
],
'custom_field_value_id' => '<string>'
]
],
'partner_custom_field_values' => [
[
'custom_field_id' => '<string>',
'lead_deal_id' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
],
'custom_field_value_id' => '<string>'
]
],
'tag' => [
'id' => '<string>',
'label' => '<string>',
'background_color' => '<string>',
'text_color' => '<string>',
'added' => true,
'removed' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
payload := strings.NewReader("{\n \"fields\": {\n \"stage_id\": \"<string>\",\n \"label\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"partner_custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"lead_deal_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"tag\": {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"added\": true,\n \"removed\": true\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"stage_id\": \"<string>\",\n \"label\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"partner_custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"lead_deal_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"tag\": {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"added\": true,\n \"removed\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": {\n \"stage_id\": \"<string>\",\n \"label\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"partner_custom_field_values\": [\n {\n \"custom_field_id\": \"<string>\",\n \"lead_deal_id\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n },\n \"custom_field_value_id\": \"<string>\"\n }\n ],\n \"tag\": {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"added\": true,\n \"removed\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deal_value": 123,
"total_commission_occurrences": 123,
"lead_id": "<string>",
"total_commission_value": 123,
"stage_id": "<string>",
"label": "<string>",
"created_by_user_id": "<string>",
"expiration_date": "<string>",
"expired_at": "<string>",
"currency_code": "<string>",
"stage": {
"id": "<string>",
"label": "<string>",
"series": 123
},
"created_by_user_first_name": "<string>",
"created_by_user_last_name": "<string>",
"created_by_user_email": "<string>",
"created_by_user_profile_image_id": 123,
"created_by_user_profile_image_uuid": "<string>",
"lead_company_name": "<string>",
"lead_first_name": "<string>",
"lead_last_name": "<string>",
"lead_email": "<string>",
"lead_phone_number": "<string>",
"lead_campaign_id": "<string>",
"campaign_title": "<string>",
"partnership": {
"id": "<string>",
"uuid": "<string>",
"name": "<string>",
"logo_square_id": 123,
"logo_square_uuid": "<string>",
"partnership_distributors_id": "<string>",
"distributor_name": "<string>",
"distributor_logo_square_id": 123,
"distributor_logo_square_uuid": "<string>"
},
"tags": [
{
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>"
}
],
"assigned_users": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"assigned_contacts": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"custom_fields": [
{
"id": "<string>",
"label": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
],
"custom_field_value_id": "<string>"
}
],
"has_quote": true,
"has_products": true,
"has_live_calculators": true,
"id": "<string>",
"entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0
}
],
"spiff_entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0,
"recipient_user_id": "<string>",
"recipient_contact_id": "<string>",
"recipient_name": "<string>"
}
],
"total_spiff_value": 0,
"commission_overrides": [
{
"stage_label": "<string>",
"amount": 4503599627370495,
"currency_code": "<string>",
"note": "<string>",
"document": {
"uuid": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"mime_type": "<string>"
}
}
]
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Default Response
Show child attributes
Show child attributes
Available options:
sent, received Available options:
new, converted, rejected Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
⌘I