_{WhatsApp Manager Webhook Documentation |
View on GitHub}

📋 Template Management

Introduction

The template module provides comprehensive tools to create, manage, and send messages based on WhatsApp-approved templates. Templates are essential for automated communications like notifications, promotions, and transactional messages, allowing you to maintain consistency in your communication while complying with WhatsApp's policies.

Key features:

Template creation for different categories (utility, marketing)
Version and component management (headers, bodies, footers, buttons)
Synchronization with WhatsApp API
Bulk sending of template-based messages
Advanced editing with real-time validation

📚 Table of Contents

Template Administration
- Get all templates
- Get by name
- Get by ID
- Delete templates
- Soft delete
- Hard delete
Edit Templates
- Component management
- Validations
- Error handling
Create Templates
- Utility templates
- Marketing templates
- With images
- With buttons
- Variations
Send Messages with Templates

Template Administration

Get all templates for a WhatsApp business account
Retrieves all templates for a WhatsApp business account and stores them in the database.
Makes a request to the WhatsApp API to get all templates associated with the account.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get a WhatsApp Business Account instance
$account = WhatsappBusinessAccount::find($accountId);

// Get all templates for the account
Whatsapp::template()->getTemplates($account);

Get a template by name
Makes a request to the WhatsApp API to get a template by name and stores it in the database.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get a WhatsApp Business Account instance
$account = WhatsappBusinessAccount::find($accountId);

// Get template by name
$template = Whatsapp::template()->getTemplateByName($account, 'order_confirmation');

Get a template by ID
Makes a request to the WhatsApp API to get a template by ID and stores it in the database.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get a WhatsApp Business Account instance
$account = WhatsappBusinessAccount::find($accountId);

// Get template by ID
$template = Whatsapp::template()->getTemplateById($account, '559947779843204');

Delete template from API and database simultaneously
Makes a request to the WhatsApp API to delete the selected template. There are two deletion methods: Soft Delete and Hard Delete.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get a WhatsApp Business Account instance
$account = WhatsappBusinessAccount::find($accountId);

// Soft delete
// Delete template by ID
$template = Whatsapp::template()->deleteTemplateById($account, $templateId);

// Delete template by name
$template = Whatsapp::template()->deleteTemplateByName($account, 'order_confirmation');

// Hard delete
// Delete template by ID
$template = Whatsapp::template()->deleteTemplateById($account, $templateId, true);

// Delete template by name
$template = Whatsapp::template()->deleteTemplateByName($account, 'order_confirmation', true);

Edit template in API and database simultaneously
Makes a request to the WhatsApp API to edit the selected template.

use ScriptDevelop\WhatsappManager\Models\Template;
use ScriptDevelop\WhatsappManager\Exceptions\TemplateComponentException;
use ScriptDevelop\WhatsappManager\Exceptions\TemplateUpdateException;

$template = Template::find('template-id');

try {
    $updatedTemplate = $template->edit()
        ->setName('new-template-name')
        ->changeBody('New body content {{1}}', [['New example']])
        ->removeHeader()
        ->addFooter('New footer text')
        ->removeAllButtons()
        ->addButton('URL', 'Visit site', 'https://mpago.li/2qe5G7E')
        ->addButton('QUICK_REPLY', 'Confirm')
        ->update();

    return response()->json($updatedTemplate);

} catch (TemplateComponentException $e) {
    // Handle component error
    return response()->json(['error' => $e->getMessage()], 400);

} catch (TemplateUpdateException $e) {
    // Handle update error
    return response()->json(['error' => $e->getMessage()], 500);
}

Add components to templates that didn't have them:

$template->edit()
    ->addHeader('TEXT', 'Added header')
    ->addFooter('New footer')
    ->addButton('PHONE_NUMBER', 'Call', '+1234567890')
    ->update();

Remove existing components:

$template->edit()
    ->removeFooter()
    ->removeAllButtons()
    ->update();

Work with specific components:

$editor = $template->edit();

// Check and modify header
if ($editor->hasHeader()) {
    $headerData = $editor->getHeader();
    if ($headerData['format'] === 'TEXT') {
        $editor->changeHeader('TEXT', 'Updated header');
    }
} else {
    $editor->addHeader('TEXT', 'New header');
}

// Modify buttons
$buttons = $editor->getButtons();
foreach ($buttons as $index => $button) {
    if ($button['type'] === 'URL' && str_contains($button['url'], 'old-domain.com')) {
        $newUrl = str_replace('old-domain.com', 'new-domain.com', $button['url']);
        $editor->removeButtonAt($index);
        $editor->addButton('URL', $button['text'], $newUrl);
    }
}

$editor->update();

Key Features of Edit Template

1. Comprehensive component management:
    - Add, change, remove methods for each component type
    - Has methods to check existence
    - Get methods to retrieve data

2. Robust validations:
    - Component uniqueness (only one HEADER, BODY, etc.)
    - Required components (BODY always required)
    - Button limits (maximum 10)
    - Modification restrictions (cannot change category, cannot modify approved templates)

3. Atomic operations:
    - removeButtonAt: Deletes a specific button
    - removeAllButtons: Deletes all buttons
    - getButtons: Gets all current buttons

4. Error handling:
    - Specific exceptions for component issues
    - Exceptions for update failures
    - Clear and descriptive error messages

5. Intuitive workflow:
    - $template->edit() starts editing
    - Method chaining for modifications
    - update() applies changes

❤️ Support us with a GitHub Sponsors donation

You can support me as an open source developer on GitHub Sponsors:

If this project has been useful to you, you can support it with a donation through
Or via Mercadopago Colombia:

Thank you for your support 💙

Create Templates in a WhatsApp Account

Create Utility Templates

Transactional templates are ideal for notifications like order confirmations, shipping updates, etc.

Marketing template example

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get business account
$account = WhatsappBusinessAccount::first();

// Create a transactional template
$template = Whatsapp::template()
    ->createUtilityTemplate($account)
    ->setName('order_confirmation_3')
    ->setLanguage('en_US')
    ->addHeader('TEXT', 'Order Confirmation')
    ->addBody('Your order {{1}} has been confirmed.', ['12345'])
    ->addFooter('Thank you for shopping with us!')
    ->addButton('QUICK_REPLY', 'Track Order')
    ->addButton('QUICK_REPLY', 'Contact Support')
    ->save();

Create Marketing Templates

Marketing templates are useful for promotions, discounts, and mass campaigns.

Marketing template example

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get business account
$account = WhatsappBusinessAccount::first();

// Create marketing template with text
$template = Whatsapp::template()
    ->createMarketingTemplate($account)
    ->setName('personal_promotion_text_only')
    ->setLanguage('en')
    ->addHeader('TEXT', 'Our {{1}} is on!', ['Summer Sale'])
    ->addBody(
        'Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.',
        ['the end of August', '25OFF', '25%']
    )
    ->addFooter('Use the buttons below to manage your marketing subscriptions')
    ->addButton('QUICK_REPLY', 'Unsubscribe from Promos')
    ->addButton('QUICK_REPLY', 'Unsubscribe from All')
    ->save();

Create Marketing Templates with Images

Marketing templates can also include images in the header to make them more attractive.

Marketing template example

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get business account
$account = WhatsappBusinessAccount::first();

// Image path
$imagePath = storage_path('app/public/laravel-whatsapp-manager.png');

// Create marketing template with image
$template = Whatsapp::template()
    ->createMarketingTemplate($account)
    ->setName('image_template_test')
    ->setLanguage('en_US')
    ->setCategory('MARKETING')
    ->addHeader('IMAGE', $imagePath)
    ->addBody('Hi {{1}}, your order {{2}} has been shipped!', ['John', '12345'])
    ->addFooter('Thank you for your purchase!')
    ->save();

Create Marketing Templates with URL Buttons

You can add custom URL buttons to redirect users to specific pages.

Marketing template example

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Get business account
$account = WhatsappBusinessAccount::first();

// Image path
$imagePath = storage_path('app/public/laravel-whatsapp-manager.png');

// Create marketing template with image and URL buttons
$template = Whatsapp::template()
    ->createMarketingTemplate($account)
    ->setName('image_template_test_2')
    ->setLanguage('en_US')
    ->setCategory('MARKETING')
    ->addHeader('IMAGE', $imagePath)
    ->addBody('Hi {{1}}, your order {{2}} has been shipped!', ['John', '12345'])
    ->addFooter('Thank you for your purchase!')
    ->addButton('PHONE_NUMBER', 'Call Us', '+573234255686')
    ->addButton('URL', 'Track Order', 'https://mpago.li/{{1}}', ['2qe5G7E'])
    ->save();

Create Marketing Template Variations

You can create multiple template variations for different purposes.

Marketing template example

    use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
    use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

    // Get business account
    $account = WhatsappBusinessAccount::first();

    // Create marketing template variation
    $template = Whatsapp::template()
        ->createMarketingTemplate($account)
        ->setName('personal_promotion_text_only_22')
        ->setLanguage('en')
        ->addHeader('TEXT', 'Our {{1}} is on!', ['Summer Sale'])
        ->addBody(
            'Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.',
            ['the end of August', '25OFF', '25%']
        )
        ->addFooter('Use the buttons below to manage your marketing subscriptions')
        ->addButton('QUICK_REPLY', 'Unsubscribe from Promos')
        ->addButton('QUICK_REPLY', 'Unsubscribe from All')
        ->save();

Notes

Verify that images used in templates comply with WhatsApp API requirements: format (JPEG, PNG), maximum allowed size, and recommended dimensions.
URL-type buttons can accept dynamic parameters through template variables ({{1}}, {{2}}, etc.), allowing link personalization for each recipient.
If you experience issues creating templates, check the log files for detailed information about possible errors and their solutions.

❤️ Support us with a GitHub Sponsors donation

You can support me as an open source developer on GitHub Sponsors:

If this project has been useful to you, you can support it with a donation through
Or via Mercadopago Colombia:

Thank you for your support 💙

Send Messages Using Templates

Send template messages

You can send different template messages based on the template structure.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;
use ScriptDevelop\WhatsappManager\Models\WhatsappPhoneNumber;

// Get business account
$account = WhatsappBusinessAccount::first();
$phone = WhatsappPhoneNumber::first();

// Send template 1
$message = Whatsapp::template()
    ->sendTemplateMessage($phone)
    ->to('57', '3137555908')
    ->usingTemplate('order_confirmation_4')
    ->addBody(['12345'])
    ->send();

// Send template 2

$message = Whatsapp::template()
    ->sendTemplateMessage($phone)
    ->to('57', '3135666627')
    ->usingTemplate('payment_link')
    ->addHeader('TEXT', '123456')
    ->addBody(['20000'])
    ->addButton('URL', 'Pay', '1QFwRV', ['[https://mpago.li/1QFwRV]'])
    ->send();

$message = Whatsapp::template()
    ->sendTemplateMessage($phone)
    ->to('57', '3135666627')
    ->usingTemplate('payment_link')
    ->addHeader('TEXT', '123456')
    ->addBody(['20000'])
    ->addButton(
        'URL', // Button type
        'Pay', // Button text
        '1QFwRV', // Button variable (URL type only)
        ['[https://mpago.li/1QFwRV]'] // Example URL (not sent, used as reference)
    )
    ->send();

◄◄ Message Management

▲ Table of contents

Events ►►

_{WhatsApp Manager Webhook Documentation |
View on GitHub}

❤️ Support

If you find this project useful, consider supporting its development:

📄 License

MIT License - See LICENSE for more details

🚀 Getting Started

⚙️ Configuration

💬 Message Management

📋 Templates

📡 Real-time Events

🔧 Advanced

Documentation

📋 Template Management

Introduction

📚 Table of Contents

Template Administration

Key Features of Edit Template

❤️ Support us with a GitHub Sponsors donation

Or via Mercadopago Colombia:

Thank you for your support 💙

Create Templates in a WhatsApp Account

Create Utility Templates

Create Marketing Templates

Create Marketing Templates with Images

Create Marketing Templates with URL Buttons

Create Marketing Template Variations

Notes

❤️ Support us with a GitHub Sponsors donation

Or via Mercadopago Colombia:

Thank you for your support 💙

Send Messages Using Templates

Send template messages

❤️ Support

📄 License

Share this page

Enjoying the project?

🚀 Getting Started

⚙️ Configuration

💬 Message Management

📋 Templates

📡 Real-time Events

🔧 Advanced

Documentation

📋 Template Management

Introduction

📚 Table of Contents

Template Administration

Key Features of Edit Template

❤️ Support us with a GitHub Sponsors donation

Or via Mercadopago Colombia: Thank you for your support 💙

Create Templates in a WhatsApp Account

Create Utility Templates

Create Marketing Templates

Create Marketing Templates with Images

Create Marketing Templates with URL Buttons

Create Marketing Template Variations

Notes

❤️ Support us with a GitHub Sponsors donation

Or via Mercadopago Colombia: Thank you for your support 💙

Send Messages Using Templates

Send template messages

❤️ Support

📄 License

Share this page

Enjoying the project?

Or via Mercadopago Colombia:

Thank you for your support 💙

Or via Mercadopago Colombia:

Thank you for your support 💙