Templates

Templates are used for opening conversations with customers who have yet to message you, or who have not sent you a message in the last 24 hours.

Templates must be approved (have a status of APPROVED) before they can be sent. Templates may be paused or disabled automatically based on customer feedback, engagement, or for violations of WhatsApp Policies.

Types of Templates

Message templates can be categorized as:

• Marketing templates – Enable businesses to achieve a wide range of goals, from generating awareness to driving sales and retargeting customers.
• Utility templates – Follow up on user actions or requests.
• Authentication templates – Verify a user’s identity, potentially at various steps of the customer journey.

Marketing Template Guidelines

Marketing templates are our most flexible. They can enable businesses to achieve a wide range of goals, from generating awareness to driving sales and more.

Note: Examples are illustrative only. Templates with similar content may be categorized differently based on the exact content.

Message Objective: Awareness

Message Objective: Sales

Message Objective: Retargeting

Message Objective: App Promotion

Message Objective: Build Customer Relationships

Also considered marketing:

• Templates with mixed content (e.g. order update with a promo).
• Templates where contents are unclear (e.g. only “1” or “Congratulations!”).

Utility Template Guidelines

Utility templates are typically triggered by a user action or request. They must include specificity about the active or ongoing transaction, account, subscription, or interaction.

Message Objective: Opt-In Management

Message Objective: Order Management

Message Objective: Account Alerts or Updates

Message Objective: Feedback Surveys

Message Objective: Continue a Conversation

Authentication Template Guidelines

Authentication templates verify a user’s identity (with alphanumeric codes). Only authentication templates can send one-time passcodes.

Message Objective: Authentication

That’s it! Feel free to customize or expand the examples as needed.

Create Templates on Banricom

🔐 Authentication Requirements

All API requests require two authentication headers:

📌 Important Security Notes:

• Treat your x-api-key like a password - never expose it in client-side code
• Always make requests to our API over HTTPS
• Rotate your API keys periodically via the developer dashboard

📜 Hello World Template Example

POST /whatsapp/templates/create HTTP/1.1
Host: api.banricom.com
x-api-key: your_app_key_here_12345
x-app-id: your_app_id_here_67890
Content-Type: application/json

{
    "templateCategory": "marketing",
    "templateName": "Testing",
    "headerOption": "text",
    "headerText" : "Hello world",
    "body": "Welcome and congratulations!! \n This message demonstrates your ability to send a WhatsApp message using APIs.",
    "WabaId": 225****056,
}

✅ Successful Response (200 OK)

{
  "success": true,
  "data": {
    "app_name": "test-app",
    "response": [
      {
        "Id": "000000000000000000000000",
        "Status": "APPROVED",
        "Category": "MARKETING",
        "TemplateID": "742******492"
      }
    ]
  }
}

📜 Create template with header variable

POST /whatsapp/templates/create HTTP/1.1
Host: api.banricom.com
x-api-key: your_app_key_here_12345
x-app-id: your_app_id_here_67890
Content-Type: application/json

{
    "templateCategory": "MARKETING",
    "templateName": "Testing_two",
    "headerOption": "text",
    "headerText": "Dear {{names}}",
    "HeaderVariables": {
        "names": "John Doe"
    },
    "body": "Welcome and congratulations!! This message demonstrates your ability to send a WhatsApp message using APIs.",
    "WabaId": 225****056
}

✅ Successful Response (200 OK)

{
  "success": true,
  "data": {
    "app_name": "test-app",
    "response": [
      {
        "Id": "000000000000000000000000",
        "Status": "APPROVED",
        "Category": "MARKETING",
        "TemplateID": "742******492"
      }
    ]
  }
}

📜 Create Template with Media Header

Endpoint

POST https://api.banricom.com/whatsapp/templates/create

Description

Creates a WhatsApp Business template with a media header (document, image, or video).

Authentication

• Requires API key and app ID in headers

Request

Headers

Form Data

Payload Structure

{
  "templateCategory": "MARKETING",
  "templateName": "string",
  "headerOption": "document|image|video",
  "body": "string",
  "WabaId": "number"
}

Sample Request

curl -X POST \
  -H "x-api-key: your_app_key_here_12345" \
  -H "x-app-id: your_app_id_here_67890" \
  -F "[email protected]" \
  -F "payload='{
    \"templateCategory\": \"MARKETING\",
    \"templateName\": \"Promo Offer\",
    \"headerOption\": \"document\",
    \"body\": \"Check our new offers!\",
    \"WabaId\": 22****56
  }'" \
  https://api.banricom.com/whatsapp/templates/create

✅ Successful Response (200 OK)

{
  "success": true,
  "data": {
    "app_name": "test-app",
    "response": [
      {
        "Id": "000000000000000000000000",
        "Status": "APPROVED",
        "Category": "MARKETING",
        "TemplateID": "742******492"
      }
    ]
  }
}