Skip to main content
POST
Preview communication group

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
Maximum string length: 255
Example:

"Active Members"

creditor_profile_state
enum<string>
required
Available options:
all_active_members,
active_members_with_pending_notice_responses,
all_pending_members,
pending_members_with_pending_notice_responses,
all_yn_prospects,
yn_prospects_with_pending_notice_responses,
all_consumer_prospects,
consumer_prospects_with_pending_notice_responses,
all_profiles_with_yn_closed_offer,
all_profiles_with_yn_closed_offer_balances
Example:

"all_active_members"

send_to
enum<string>
required
Available options:
company_email_only,
contact_emails_only,
company_and_contact_emails
Example:

"company_email_only"

Response

Communication group preview returned.

data
object
required
Last modified on July 19, 2026