> ## Documentation Index > Fetch the complete documentation index at: https://docs.younegotiate.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview group size > Preview how many consumers and how much current balance will be included before creating or updating a communication group. ## OpenAPI ````yaml /api/creditor.openapi.yaml post /communications/groups/preview openapi: 3.1.0 info: title: YouNegotiate Creditor API version: '2.0' description: >- Stateless API endpoints for creditor portal authentication and account access. servers: - url: https://api.creditor.younegotiate.com description: Production security: [] tags: - name: System description: Public creditor domain system and health endpoints. - name: Authentication description: Creditor registration, login, password, and email verification endpoints. - name: Account Settings description: >- Authenticated creditor profile, contact, operating-hours, and profile-image endpoints. - name: Account Profile description: >- Creditor onboarding profile, membership, billing, and setup status endpoints. - name: Setup Wizard description: >- Creditor setup wizard status, required-step completion, and optional-step completion. - name: Dashboard description: Creditor dashboard work queues and performance widgets. - name: Import / Export description: >- Creditor consumer import upload sessions, queued imports, history, downloads, and failed-row files. - name: Membership Settings description: >- Creditor membership dashboard, plan changes, payment method, cancellation, special-plan inquiry, and over-limit retry endpoints. - name: Merchant Account description: >- Existing merchant processor credentials, Tilled onboarding, and merchant application endpoints. - name: Header Profiles description: >- CSV header profile upload, mapping, download, and setup wizard completion endpoints. - name: SFTP Connections description: >- Creditor-managed SFTP connection profiles for imports, exports, and setup wizard completion. - name: Sub Accounts description: >- Creditor-managed sub account list, export, create, update, and delete endpoints. - name: Pay Terms Offers description: >- Creditor-managed master, sub-account, group, and group-sub-account Pay Terms endpoints. - name: Individual Custom Offers description: Creditor individual custom offer list endpoints. - name: Negotiations description: >- Creditor negotiation work queues, including notice responses and offer review counts. - name: Communications / CFPB Validation Letter description: >- CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export, and print/download actions. - name: Communications / EcoLetter Template description: >- Creditor EcoLetter template management for secure eLetter communications and campaigns. - name: Communications / Groups description: >- Creditor communication group management for dynamic consumer targeting and campaign selection. - name: Communications / Schedule Campaign description: >- Creditor EcoLetter campaign scheduling, quote, immediate send, and delivery queue endpoints. - name: Communications / Campaign Tracker description: >- Creditor campaign tracker reporting, refresh, and consumer export endpoints. - name: Consumer Profiles description: Creditor Consumer Profiles list, filter options, and CSV export endpoints. - name: Terms & Conditions description: Creditor-managed master and sub-account Terms & Conditions templates. - name: About Us & Contact description: Creditor-managed company About Us content shown to consumers. - name: Logo & Links description: >- Creditor-managed master and sub-account personalized logo colors, size, and consumer link metadata. - name: Users description: >- Master creditor user management, invitations, and account deletion endpoints. paths: /communications/groups/preview: post: tags: - Communications / Groups summary: Preview group size description: >- Preview how many consumers and how much current balance will be included before creating or updating a communication group. operationId: creditorPreviewCommunicationGroup requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CommunicationGroupPreviewRequest' example: 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' responses: '200': description: Communication group preview returned. content: application/json: schema: $ref: '#/components/schemas/CommunicationGroupPreviewResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/ActiveMembershipRequired' '422': $ref: '#/components/responses/ValidationError' security: - bearerAuth: [] components: schemas: CommunicationGroupPreviewRequest: type: object additionalProperties: false required: - consumer_state properties: subclient_id: oneOf: - type: integer - type: string enum: - master - type: 'null' description: >- `master` or null targets master accounts. Sub-account creditor users are forced to their assigned sub-account. file_upload_history_id: oneOf: - type: integer - type: string enum: - all - type: 'null' description: >- `all` or null targets all active accounts; an integer targets one completed import file. consumer_state: $ref: '#/components/schemas/CommunicationGroupState' custom_rules: $ref: '#/components/schemas/CommunicationGroupCustomRulesRequest' CommunicationGroupPreviewResponse: type: object required: - data properties: data: $ref: '#/components/schemas/CommunicationGroupSnapshot' CommunicationGroupState: type: string enum: - 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 CommunicationGroupCustomRulesRequest: type: object additionalProperties: false properties: expiry_date: $ref: '#/components/schemas/CommunicationGroupDateRange' placement_date: $ref: '#/components/schemas/CommunicationGroupDateRange' CommunicationGroupSnapshot: type: object required: - total_count - total_balance - total_balance_label properties: total_count: type: integer example: 10 total_balance: type: number format: float example: 1250.5 total_balance_label: type: string example: $1,250.50 MessageResponse: type: object required: - message properties: message: type: string ValidationErrorResponse: type: object required: - message - errors properties: message: type: string errors: type: object additionalProperties: type: array items: type: string CommunicationGroupDateRange: type: object additionalProperties: false required: - start_date - end_date properties: start_date: type: string format: date example: '2026-01-01' end_date: type: string format: date example: '2026-01-31' responses: Unauthenticated: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' ActiveMembershipRequired: description: Authenticated creditor does not have an active membership. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' example: message: An active membership is required. ValidationError: description: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Sanctum token ````