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

# Send Campaign

> **API endpoint**: `https://api.vodafone.com/api/v2`
  
Send an SMS campaign to one or more recipients using an approved Sender
ID on your Vodafone Bulk Text account.

Use this endpoint for customer updates, appointment reminders, staff
notifications, promotional messages, and other business communications.

You can schedule a campaign for later delivery, add a campaign name for
reporting, and include per-recipient `notifyId` values to align messages
with records in your own systems.




## OpenAPI

````yaml POST /api/v2/Campaign
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:
  /api/v2/Campaign:
    post:
      tags:
        - Bulk Text
      summary: Send an SMS campaign
      description: |
        **API endpoint**: `https://api.vodafone.com/api/v2`
          
        Send an SMS campaign to one or more recipients using an approved Sender
        ID on your Vodafone Bulk Text account.

        Use this endpoint for customer updates, appointment reminders, staff
        notifications, promotional messages, and other business communications.

        You can schedule a campaign for later delivery, add a campaign name for
        reporting, and include per-recipient `notifyId` values to align messages
        with records in your own systems.
      operationId: Campaign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueCampaignRequest'
            examples:
              basicCampaign:
                summary: Send a customer update now
                description: Send one SMS campaign immediately.
                value:
                  text: Your appointment reminder from YourCompany.
                  from: Vodafone
                  recipientInfo:
                    - msisdn: 35386xxxxxxx
              basicCampaignMsisdnNotify:
                summary: Send a tracked customer update
                description: >-
                  Send an SMS campaign with references that match recipients in
                  your own systems.
                value:
                  text: Your delivery update from YourCompany.
                  from: Vodafone
                  recipientInfo:
                    - msisdn: 35386xxxxxxx
                      notifyId: user-123
                    - msisdn: 35387xxxxxxx
                      notifyId: user-987
              futureCampaign:
                summary: Schedule a customer update
                description: Schedule an SMS campaign for future delivery.
                value:
                  text: Your scheduled service reminder from YourCompany.
                  from: Vodafone
                  recipientInfo:
                    - msisdn: 35386xxxxxxx
                  sendAt: 2026-03-28T20:00Z
      responses:
        '200':
          description: Campaign accepted or scheduled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignResponse'
              examples:
                successResponse:
                  summary: Campaign scheduled
                  value:
                    success: true
                    message: Campaign scheduled
                    errors: []
        '400':
          description: >-
            The campaign request is missing required information or contains
            invalid values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignResponse'
              examples:
                badRequestResponse:
                  summary: Review the campaign details
                  value:
                    success: false
                    message: Error scheduling campaign
                    errors:
                      - Message text cannot be empty.
        '401':
          description: The access token is missing, expired, or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignResponse'
              examples:
                unauthorizedResponse:
                  summary: Check the access token
                  value:
                    success: false
                    message: Unauthorized
                    errors:
                      - 401 Unauthorized
        '415':
          description: The request must use `application/json`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignResponse'
              examples:
                unsupportedMediaTypeResponse:
                  summary: Use JSON content
                  value:
                    success: false
                    message: Unsupported Media Type
                    errors:
                      - Only application/json is allowed.
      security:
        - BearerAuth: []
      servers:
        - url: https://api.vodafone.com
          description: Vodafone Bulk Text API server
components:
  schemas:
    QueueCampaignRequest:
      type: object
      description: Campaign details for sending Vodafone Bulk Text SMS messages.
      required:
        - text
        - from
        - recipientInfo
      properties:
        text:
          type: string
          description: >
            Customer-facing SMS message text. Keep it clear, concise, and
            suitable for the recipients receiving it.
          maxLength: 2000
        from:
          type: string
          description: |
            Sender ID displayed on the recipient handset.
            This value must be one of the approved Sender IDs assigned to your
            Vodafone Bulk Text account.
            If an unregistered or unauthorised Sender ID is used, the request
            will be rejected.
          maxLength: 20
        recipientInfo:
          type: array
          items:
            $ref: '#/components/schemas/RecipientInfo'
          description: Recipients who will receive this campaign message.
        campaignName:
          type: string
          description: Campaign name used by your team for tracking and reporting.
          default: API Broadcast
          maxLength: 30
        sendAt:
          type: string
          description: 'Scheduled send date and time in UTC. Format: yyyy-MM-ddTHH:mmZ.'
          format: date-time
    CampaignResponse:
      type: object
      description: Standard Vodafone Bulk Text API response.
      properties:
        success:
          type: boolean
          description: Indicates whether the request was accepted.
        message:
          type:
            - string
            - 'null'
          description: Human-readable status message for the request.
        errors:
          type:
            - array
            - 'null'
          description: Validation or processing messages to review.
          items:
            type: string
    RecipientInfo:
      type: object
      required:
        - msisdn
      properties:
        msisdn:
          type: string
          description: >
            Recipient mobile number in MSISDN format, for example
            `353871234567`.


            Irish numbers without the international prefix `353` are accepted,

            for example `0871234567`.


            Accepted Irish MSISDN examples: `353871234567` or `0871234567`.


            All international MSISDNs must include their international prefix.


            Accepted international examples:  

            United Kingdom: `44...`  

            France: `33...`
          maxLength: 20
        notifyId:
          type: string
          description: Optional recipient-level reference for tracking in your own systems.
          maxLength: 30
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Get a JWT access token from `https://auth.vodafone.com/token`. Pass it
        in the `Authorization` header as `Bearer {token}` when calling Vodafone
        Bulk Text API endpoints.

````