Skip to main content
POST
Preview group size

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
consumer_state
enum<string>
required
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
company_id

all or null targets all companies; an integer targets one company.

custom_rules
object

Response

Communication group preview returned.

data
object
required
Last modified on July 20, 2026