> ## 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.

# Communication campaign options

> Return templates, groups, frequencies, and schedule day options for the EcoMail Hub Communications > Schedule Campaign form.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /communications/campaigns/options
openapi: 3.1.0
info:
  title: YouNegotiate EcoMail Hub API
  version: '2.0'
  description: Stateless API endpoints for EcoMail Hub / EcoPortal users.
servers:
  - url: https://api.ecomailhub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public EcoMail Hub domain system and health endpoints.
  - name: Authentication
    description: EcoMail Hub login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated EcoMail Hub user profile endpoints.
  - name: Dashboard
    description: EcoMail Hub dashboard summary and notice-response bucket endpoints.
  - name: Manage Consumers
    description: >-
      EcoMail Hub consumer identity grouping and notice-response count
      endpoints.
  - name: Manage Creditors
    description: >-
      EcoMail Hub creditor profile and company-only member profile table
      endpoints.
  - name: Import Creditor Profiles
    description: EcoMail Hub creditor profile CSV import endpoints.
  - name: Manage Notice Response
    description: >-
      EcoMail Hub top-level notice-response review, reassignment, and close
      endpoints.
  - name: Manage Users
    description: EcoMail Hub user account management endpoints.
  - name: Reports
    description: EcoMail Hub one-time and scheduled CSV report endpoints.
  - name: Communications
    description: EcoMail Hub communication template editor endpoints.
paths:
  /communications/campaigns/options:
    get:
      tags:
        - Communications
      summary: Communication campaign options
      description: >-
        Return templates, groups, frequencies, and schedule day options for the
        EcoMail Hub Communications > Schedule Campaign form.
      operationId: ecomailhubCommunicationCampaignOptions
      responses:
        '200':
          description: Communication campaign options returned.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/EcomailhubCommunicationCampaignOptionsResponse
              example:
                data:
                  templates:
                    - id: 15
                      value: 15
                      label: Welcome Creditor
                  groups:
                    - id: 21
                      value: 21
                      label: Active Members
                  frequencies:
                    - value: once
                      label: Once
                    - value: daily
                      label: Daily
                  days_of_week:
                    - value: 1
                      label: Monday
                  days_of_month:
                    - value: 15
                      label: '15'
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    EcomailhubCommunicationCampaignOptionsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - templates
            - groups
            - frequencies
            - days_of_week
            - days_of_month
          properties:
            templates:
              type: array
              items:
                $ref: '#/components/schemas/EcomailhubCommunicationCampaignIdOption'
            groups:
              type: array
              items:
                $ref: '#/components/schemas/EcomailhubCommunicationCampaignIdOption'
            frequencies:
              type: array
              items:
                $ref: >-
                  #/components/schemas/EcomailhubCommunicationCampaignStringOption
            days_of_week:
              type: array
              items:
                $ref: '#/components/schemas/EcomailhubCommunicationCampaignDayOption'
            days_of_month:
              type: array
              items:
                $ref: '#/components/schemas/EcomailhubCommunicationCampaignDayOption'
    EcomailhubCommunicationCampaignIdOption:
      type: object
      required:
        - id
        - value
        - label
      properties:
        id:
          type: integer
          example: 15
        value:
          type: integer
          example: 15
        label:
          type: string
          example: Welcome Creditor
    EcomailhubCommunicationCampaignStringOption:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: string
          example: weekly
        label:
          type: string
          example: Weekly
    EcomailhubCommunicationCampaignDayOption:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: integer
          example: 1
        label:
          type: string
          example: Monday
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum

````