Preview group size
curl --request POST \
--url https://api.creditor.younegotiate.com/communications/groups/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subclient_id": "master",
"file_upload_history_id": "all",
"consumer_state": "not_viewed_offer",
"custom_rules": {
"placement_date": {
"start_date": "2026-01-01",
"end_date": "2026-01-31"
}
}
}
'import requests
url = "https://api.creditor.younegotiate.com/communications/groups/preview"
payload = {
"subclient_id": "master",
"file_upload_history_id": "all",
"consumer_state": "not_viewed_offer",
"custom_rules": { "placement_date": {
"start_date": "2026-01-01",
"end_date": "2026-01-31"
} }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subclient_id: 'master',
file_upload_history_id: 'all',
consumer_state: 'not_viewed_offer',
custom_rules: {placement_date: {start_date: '2026-01-01', end_date: '2026-01-31'}}
})
};
fetch('https://api.creditor.younegotiate.com/communications/groups/preview', 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.creditor.younegotiate.com/communications/groups/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subclient_id' => 'master',
'file_upload_history_id' => 'all',
'consumer_state' => 'not_viewed_offer',
'custom_rules' => [
'placement_date' => [
'start_date' => '2026-01-01',
'end_date' => '2026-01-31'
]
]
]),
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.creditor.younegotiate.com/communications/groups/preview"
payload := strings.NewReader("{\n \"subclient_id\": \"master\",\n \"file_upload_history_id\": \"all\",\n \"consumer_state\": \"not_viewed_offer\",\n \"custom_rules\": {\n \"placement_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-01-31\"\n }\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.creditor.younegotiate.com/communications/groups/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subclient_id\": \"master\",\n \"file_upload_history_id\": \"all\",\n \"consumer_state\": \"not_viewed_offer\",\n \"custom_rules\": {\n \"placement_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-01-31\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creditor.younegotiate.com/communications/groups/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subclient_id\": \"master\",\n \"file_upload_history_id\": \"all\",\n \"consumer_state\": \"not_viewed_offer\",\n \"custom_rules\": {\n \"placement_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-01-31\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"total_count": 10,
"total_balance": 1250.5,
"total_balance_label": "$1,250.50"
}
}{
"message": "<string>"
}{
"message": "An active membership is required."
}{
"message": "<string>",
"errors": {}
}Preview group size
Preview how many consumers and how much current balance will be included before creating or updating a communication group.
POST
/
communications
/
groups
/
preview
Preview group size
curl --request POST \
--url https://api.creditor.younegotiate.com/communications/groups/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subclient_id": "master",
"file_upload_history_id": "all",
"consumer_state": "not_viewed_offer",
"custom_rules": {
"placement_date": {
"start_date": "2026-01-01",
"end_date": "2026-01-31"
}
}
}
'import requests
url = "https://api.creditor.younegotiate.com/communications/groups/preview"
payload = {
"subclient_id": "master",
"file_upload_history_id": "all",
"consumer_state": "not_viewed_offer",
"custom_rules": { "placement_date": {
"start_date": "2026-01-01",
"end_date": "2026-01-31"
} }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subclient_id: 'master',
file_upload_history_id: 'all',
consumer_state: 'not_viewed_offer',
custom_rules: {placement_date: {start_date: '2026-01-01', end_date: '2026-01-31'}}
})
};
fetch('https://api.creditor.younegotiate.com/communications/groups/preview', 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.creditor.younegotiate.com/communications/groups/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subclient_id' => 'master',
'file_upload_history_id' => 'all',
'consumer_state' => 'not_viewed_offer',
'custom_rules' => [
'placement_date' => [
'start_date' => '2026-01-01',
'end_date' => '2026-01-31'
]
]
]),
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.creditor.younegotiate.com/communications/groups/preview"
payload := strings.NewReader("{\n \"subclient_id\": \"master\",\n \"file_upload_history_id\": \"all\",\n \"consumer_state\": \"not_viewed_offer\",\n \"custom_rules\": {\n \"placement_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-01-31\"\n }\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.creditor.younegotiate.com/communications/groups/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subclient_id\": \"master\",\n \"file_upload_history_id\": \"all\",\n \"consumer_state\": \"not_viewed_offer\",\n \"custom_rules\": {\n \"placement_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-01-31\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creditor.younegotiate.com/communications/groups/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subclient_id\": \"master\",\n \"file_upload_history_id\": \"all\",\n \"consumer_state\": \"not_viewed_offer\",\n \"custom_rules\": {\n \"placement_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-01-31\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"total_count": 10,
"total_balance": 1250.5,
"total_balance_label": "$1,250.50"
}
}{
"message": "<string>"
}{
"message": "An active membership is required."
}{
"message": "<string>",
"errors": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Available options:
all_active, not_viewed_offer, expired_negotiation, viewed_offer_but_no_response, open_negotiations, not_responded_to_counter_offer, negotiated_payoff_but_pending_payment, negotiated_plan_but_pending_payment, failed_or_skip_more_than_two_payments_consecutively, reported_not_paying, disputed, notice_response_added, notice_response_returned master or null targets master accounts. Sub-account creditor users are forced to their assigned sub-account.
all or null targets all active accounts; an integer targets one completed import file.
Show child attributes
Show child attributes
Response
Communication group preview returned.
Show child attributes
Show child attributes
Last modified on July 20, 2026
Was this page helpful?
⌘I

