> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vfbulk.ie/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Returns `200 OK` when the Vodafone Bulk Text service is online.



## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: Vodafone Bulk Text OAuth API
  description: >
    Use the Vodafone Bulk Text OAuth API to authenticate securely, send SMS

    campaigns, and check the Sender IDs available on your account.


    This API suite supports practical business communication from your CRM,

    application, or customer database:


    1. **Authentication**: Get a JWT access token from
    `https://auth.vodafone.com`

    and use it to protect API requests.


    2. **Campaign messaging**: Send customer alerts, appointment reminders,

    staff updates, promotions, and other time-sensitive SMS messages through

    `https://api.vodafone.com`.
  version: 2.0.0
  contact:
    name: Vodafone Bulk Text Support
    email: bulktext.ie@vodafone.com
  x-brand:
    name: Vodafone Ireland
    voice: Confident, direct, practical, and business-focused.
    tone:
      - Clear and action-oriented.
      - Security-aware without sounding alarmist.
      - Commercially focused, with emphasis on reliable customer communication.
      - Short, scannable wording that helps customers complete the task.
    colors:
      primary: '#E60000'
      secondary: '#121212'
      surface: '#F2F2F2'
      text: '#0D0D0D'
      error: '#D93025'
    typography:
      primaryFamily: Vodafone, Open Sans, sans-serif
      style: Compact, legible, and conversion-focused.
servers:
  - url: https://api.vodafone.com
    description: Vodafone Bulk Text API server
security: []
tags:
  - name: Authentication
    description: Get access tokens for secure Vodafone Bulk Text API requests.
  - name: Bulk Text
    description: Send reliable SMS campaigns and check your approved Sender IDs.
paths:
  /health:
    get:
      tags:
        - Bulk Text
      summary: Check service health
      description: Returns `200 OK` when the Vodafone Bulk Text service is online.
      operationId: getHealth
      responses:
        '200':
          description: Service is online.
      security: []
      servers:
        - url: https://api.vodafone.com
          description: Vodafone Bulk Text API server

````