Templates

Endpoints for managing WhatsApp message templates

Get Message Template Library

get

Retrieve message templates from the template library for a WABA.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Responses

200

Template library retrieved successfully

application/json

Response payload containing a list of templates from the library

401

Unauthorized

application/json

500

Internal server error

application/json

get/message_template_library

HTTPcURLJavaScriptPython

GET /message_template_library HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "data": [
      {
        "body": "Hi {{1}}, ...",
        "body_param_types": [
          "text"
        ],
        "body_params": [
          "text"
        ],
        "buttons": [
          {
            "phone_number": "[phone]",
            "text": "Reschedule",
            "type": "URL",
            "url": {
              "base_url": "https://www.example.com/{{1}}",
              "url_suffix_example": "https://www.example.com/demo"
            }
          }
        ],
        "category": "UTILITY",
        "header": "Your account balance is low",
        "industry": [
          "text"
        ],
        "language": "en_US",
        "name": "low_balance_warning_1",
        "topic": "PAYMENTS",
        "usecase": "LOW_BALANCE_WARNING"
      }
    ],
    "paging": {
      "cursors": {
        "after": "MjQZD",
        "before": "MAZDZD"
      },
      "next": "https://api.example.com/message_template_library?after=abc123"
    }
  }
]

List Message Templates

get

Retrieve message templates. Returns paginated results with template details including status, category, components, and quality scores.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Query parameters

fieldsstringOptional

Comma-separated list of fields to include (e.g. id,name,status,components)

limitintegerOptional

Maximum number of templates to return per page

afterstringOptional

Cursor for the next page of results

beforestringOptional

Cursor for the previous page of results

Responses

200

Templates retrieved successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

get/message_templates

HTTPcURLJavaScriptPython

GET /message_templates HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "ad_account_id": "text",
      "ad_adset_id": "text",
      "ad_campaign_id": "text",
      "ad_id": "text",
      "bid_spec": {
        "bid_amount": 1,
        "bid_strategy": "text"
      },
      "category": "UTILITY",
      "components": [
        {
          "add_security_recommendation": true,
          "buttons": [
            {
              "autofill_text": "text",
              "flow_action": "navigate",
              "flow_id": "text",
              "flow_json": "text",
              "flow_name": "text",
              "navigate_screen": "text",
              "otp_type": "ONE_TAP",
              "package_name": "text",
              "phone_number": "[phone]",
              "signature_hash": "text",
              "text": "Visit us",
              "type": "URL",
              "url": "https://www.example.com"
            }
          ],
          "code_expiration_minutes": 1,
          "example": {
            "body_text": [
              [
                "text"
              ]
            ],
            "header_handle": [
              "text"
            ],
            "header_text": [
              "text"
            ]
          },
          "format": "TEXT",
          "text": "Hello {{1}}, your order is ready.",
          "type": "BODY"
        }
      ],
      "correct_category": "UTILITY",
      "cta_url_link_tracking_opted_out": true,
      "degrees_of_freedom_spec": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "display_format": "ORDER_DETAILS",
      "health_status": {
        "can_send_message": "AVAILABLE"
      },
      "id": "123456789",
      "is_primary_device_delivery_only": true,
      "is_sms_fallback_enabled": true,
      "language": "en_US",
      "last_updated_time": 1,
      "library_template_name": "welcome_template",
      "message_send_ttl_seconds": 1,
      "name": "order_update",
      "parameter_format": "POSITIONAL",
      "previous_category": "MARKETING",
      "quality_score": {
        "date": 1,
        "reason": "text",
        "reasons": [
          "text"
        ],
        "score": "GREEN"
      },
      "rejected_reason": "NONE",
      "source": "manual",
      "status": "APPROVED",
      "sub_category": "ORDER_STATUS"
    }
  ],
  "paging": {
    "cursors": {
      "after": "MjQZD",
      "before": "MAZDZD"
    },
    "next": "text",
    "previous": "text"
  }
}

Create Message Template

post

Create a new message template. Templates must be approved before they can be used to send messages. Supports cloning from the Meta Template Library.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

application/json

Message template payload

allow_category_changebooleanOptional

categorystringOptionalExample: UTILITY

cta_url_link_tracking_opted_outbooleanOptional

display_formatstringOptionalExample: ORDER_DETAILS

is_primary_device_delivery_onlybooleanOptional

languagestringOptionalExample: en_US

library_template_namestringOptionalExample: welcome_template

message_send_ttl_secondsintegerOptional

namestringOptionalExample: order_update

parameter_formatstringOptionalExample: POSITIONAL

send_typestringOptionalExample: direct

sub_categorystringOptionalExample: ORDER_STATUS

Responses

200

Template created successfully

application/json

categorystringOptionalExample: UTILITY

idstringOptionalExample: {hsm-id}

statusstringOptionalExample: APPROVED

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal server error

application/json

post/message_templates

HTTPcURLJavaScriptPython

POST /message_templates HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1039

{
  "allow_category_change": true,
  "category": "UTILITY",
  "components": [
    {
      "add_security_recommendation": true,
      "buttons": [
        {
          "autofill_text": "text",
          "flow_action": "navigate",
          "flow_id": "text",
          "flow_json": "text",
          "flow_name": "text",
          "navigate_screen": "text",
          "otp_type": "ONE_TAP",
          "package_name": "text",
          "phone_number": "[phone]",
          "signature_hash": "text",
          "text": "Visit us",
          "type": "URL",
          "url": "https://www.example.com"
        }
      ],
      "code_expiration_minutes": 1,
      "example": {
        "body_text": [
          [
            "text"
          ]
        ],
        "header_handle": [
          "text"
        ],
        "header_text": [
          "text"
        ]
      },
      "format": "TEXT",
      "text": "Hello {{1}}, your order is ready.",
      "type": "BODY"
    }
  ],
  "cta_url_link_tracking_opted_out": true,
  "display_format": "ORDER_DETAILS",
  "is_primary_device_delivery_only": true,
  "language": "en_US",
  "library_template_body_inputs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "library_template_button_inputs": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "library_template_name": "welcome_template",
  "message_send_ttl_seconds": 1,
  "name": "order_update",
  "parameter_format": "POSITIONAL",
  "send_type": "direct",
  "sub_category": "ORDER_STATUS"
}

{
  "category": "UTILITY",
  "id": "{hsm-id}",
  "status": "APPROVED"
}

Delete Message Templates

delete

Delete message templates. Can delete by name (all languages), by specific template ID, or by multiple template IDs.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Query parameters

namestringOptional

Template name to delete (deletes all languages if hsm_id not specified)

hsm_idstringOptional

Specific template ID to delete (used with name for single-language deletion)

hsm_idsstringOptional

JSON array of template IDs to delete (max 100)

Responses

200

Templates deleted successfully

application/json

successbooleanOptionalExample: true

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

delete/message_templates

HTTPcURLJavaScriptPython

DELETE /message_templates HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Archive Message Templates

post

Archive one or more message templates for a WABA. Only approved or rejected templates can be archived. Archived templates are scheduled for deletion after 28 days.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

application/json

Template IDs to archive (up to 100)

hsm_idsstring[]OptionalExample: ["1368161468357453"]

Responses

200

Archive operation result

application/json

archived_templatesstring[]OptionalExample: ["1368161468357453"]

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/message_templates/archive

HTTPcURLJavaScriptPython

POST /message_templates/archive HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "hsm_ids": [
    "1368161468357453"
  ]
}

{
  "archived_templates": [
    "1368161468357453"
  ],
  "failed_templates": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Unarchive Message Templates

post

Unarchive one or more archived message templates for a WABA within the 28-day window. Restores templates to their previous status (defaults to APPROVED if no previous status is available). Resets the inactivity clock.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

application/json

Template IDs to unarchive (up to 100)

hsm_idsstring[]OptionalExample: ["1368161468357453"]

Responses

200

Unarchive operation result

application/json

unarchived_templatesstring[]OptionalExample: ["1368161468357453"]

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/message_templates/unarchive

HTTPcURLJavaScriptPython

POST /message_templates/unarchive HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "hsm_ids": [
    "1368161468357453"
  ]
}

{
  "failed_templates": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "unarchived_templates": [
    "1368161468357453"
  ]
}

Get Message Template by ID

get

Retrieve a specific message template by its ID with all available fields.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

template_idstringRequired

Message template ID

Query parameters

fieldsstringOptional

Comma-separated list of fields to include (e.g. id,name,status,components)

Responses

200

Template retrieved successfully

application/json

ad_account_idstringOptional

ad_adset_idstringOptional

ad_campaign_idstringOptional

ad_idstringOptional

categorystringOptionalExample: UTILITY

correct_categorystringOptionalExample: UTILITY

cta_url_link_tracking_opted_outbooleanOptional

display_formatstringOptionalExample: ORDER_DETAILS

idstringOptionalExample: 123456789

is_primary_device_delivery_onlybooleanOptional

is_sms_fallback_enabledbooleanOptional

languagestringOptionalExample: en_US

last_updated_timeintegerOptional

library_template_namestringOptionalExample: welcome_template

message_send_ttl_secondsintegerOptional

namestringOptionalExample: order_update

parameter_formatstringOptionalExample: POSITIONAL

previous_categorystringOptionalExample: MARKETING

rejected_reasonstringOptionalExample: NONE

sourcestringOptionalExample: manual

statusstringOptionalExample: APPROVED

sub_categorystringOptionalExample: ORDER_STATUS

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/message_templates/{template_id}

HTTPcURLJavaScriptPython

GET /message_templates/{template_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "ad_account_id": "text",
  "ad_adset_id": "text",
  "ad_campaign_id": "text",
  "ad_id": "text",
  "bid_spec": {
    "bid_amount": 1,
    "bid_strategy": "text"
  },
  "category": "UTILITY",
  "components": [
    {
      "add_security_recommendation": true,
      "buttons": [
        {
          "autofill_text": "text",
          "flow_action": "navigate",
          "flow_id": "text",
          "flow_json": "text",
          "flow_name": "text",
          "navigate_screen": "text",
          "otp_type": "ONE_TAP",
          "package_name": "text",
          "phone_number": "[phone]",
          "signature_hash": "text",
          "text": "Visit us",
          "type": "URL",
          "url": "https://www.example.com"
        }
      ],
      "code_expiration_minutes": 1,
      "example": {
        "body_text": [
          [
            "text"
          ]
        ],
        "header_handle": [
          "text"
        ],
        "header_text": [
          "text"
        ]
      },
      "format": "TEXT",
      "text": "Hello {{1}}, your order is ready.",
      "type": "BODY"
    }
  ],
  "correct_category": "UTILITY",
  "cta_url_link_tracking_opted_out": true,
  "degrees_of_freedom_spec": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_format": "ORDER_DETAILS",
  "health_status": {
    "can_send_message": "AVAILABLE"
  },
  "id": "123456789",
  "is_primary_device_delivery_only": true,
  "is_sms_fallback_enabled": true,
  "language": "en_US",
  "last_updated_time": 1,
  "library_template_name": "welcome_template",
  "message_send_ttl_seconds": 1,
  "name": "order_update",
  "parameter_format": "POSITIONAL",
  "previous_category": "MARKETING",
  "quality_score": {
    "date": 1,
    "reason": "text",
    "reasons": [
      "text"
    ],
    "score": "GREEN"
  },
  "rejected_reason": "NONE",
  "source": "manual",
  "status": "APPROVED",
  "sub_category": "ORDER_STATUS"
}

Edit Message Template

post

Update an existing message template. Only approved or rejected templates can be edited.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

template_idstringRequired

Message template ID to edit

Body

application/json

Updated template fields

allow_category_changebooleanOptional

categorystringOptionalExample: UTILITY

cta_url_link_tracking_opted_outbooleanOptional

display_formatstringOptionalExample: ORDER_DETAILS

is_primary_device_delivery_onlybooleanOptional

message_send_ttl_secondsintegerOptional

parameter_formatstringOptionalExample: POSITIONAL

sub_categorystringOptionalExample: ORDER_STATUS

Responses

200

Template updated successfully

application/json

successbooleanOptionalExample: true

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/message_templates/{template_id}

HTTPcURLJavaScriptPython

POST /message_templates/{template_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 790

{
  "allow_category_change": true,
  "category": "UTILITY",
  "components": [
    {
      "add_security_recommendation": true,
      "buttons": [
        {
          "autofill_text": "text",
          "flow_action": "navigate",
          "flow_id": "text",
          "flow_json": "text",
          "flow_name": "text",
          "navigate_screen": "text",
          "otp_type": "ONE_TAP",
          "package_name": "text",
          "phone_number": "[phone]",
          "signature_hash": "text",
          "text": "Visit us",
          "type": "URL",
          "url": "https://www.example.com"
        }
      ],
      "code_expiration_minutes": 1,
      "example": {
        "body_text": [
          [
            "text"
          ]
        ],
        "header_handle": [
          "text"
        ],
        "header_text": [
          "text"
        ]
      },
      "format": "TEXT",
      "text": "Hello {{1}}, your order is ready.",
      "type": "BODY"
    }
  ],
  "cta_url_link_tracking_opted_out": true,
  "display_format": "ORDER_DETAILS",
  "is_primary_device_delivery_only": true,
  "message_send_ttl_seconds": 1,
  "parameter_format": "POSITIONAL",
  "sub_category": "ORDER_STATUS"
}

{
  "success": true
}

Compare Message Templates

get

Compare two message templates by block rate, message send volume, and top block reason. Both templates must be in the same WhatsApp Business account and must have been sent at least 1,000 times in the specified timeframe. Lookback windows are limited to 7, 30, 60, and 90 days.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

template_idstringRequired

ID of the target WhatsApp Message Template

Query parameters

template_idsstringRequired

JSON array with the ID of the template to compare against (e.g. [1533406637136032])

startintegerRequired

UNIX timestamp for the start of the comparison timeframe

endintegerRequired

UNIX timestamp for the end of the comparison timeframe

Responses

200

Comparison results including block rate, send volume, and top block reason

application/json

Response payload for Meta's Template Comparison API

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/message_templates/{template_id}/compare

HTTPcURLJavaScriptPython

GET /message_templates/{template_id}/compare?template_ids=text&start=1&end=1 HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "metric": "BLOCK_RATE",
      "number_values": [
        {
          "key": "5289179717853347",
          "value": 1273
        }
      ],
      "order_by_relative_metric": [
        "text"
      ],
      "string_values": [
        {
          "key": "5289179717853347",
          "value": "UNKNOWN_BLOCK_REASON"
        }
      ],
      "type": "RELATIVE"
    }
  ]
}

Deprecated

Get Templates

get

Deprecated: use GET /message_templates instead.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Responses

200

Templates retrieved successfully

application/json

objectOptional

401

Unauthorized

application/json

500

Internal server error

application/json

get/v1/configs/templates

HTTPcURLJavaScriptPython

GET /v1/configs/templates HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{}

Deprecated

Create Template

post

Deprecated: use POST /message_templates instead

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

application/jsontext/plain

objectOptional

Responses

200

Template created successfully

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/v1/configs/templates

HTTPcURLJavaScriptPython

POST /v1/configs/templates HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

application/jsontext/plain

{}

Deprecated

Delete Template

delete

Deprecated: use DELETE /message_templates instead

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

template_namestringRequired

Template name

Query parameters

external_idstringOptional

Template id on Meta. If specified, name is ignored. Example: 1423298775400

idstringOptional

Template id on HUB. If specified, name and external_id are ignored. Example: exampleWT

Responses

200

Template deleted successfully

application/json

objectOptional

400

Bad request - empty template name

application/json

401

Unauthorized

application/json

404

Template not found

application/json

500

Internal server error

application/json

delete/v1/configs/templates/{template_name}

HTTPcURLJavaScriptPython

DELETE /v1/configs/templates/{template_name} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{}

Deprecated

Update WhatsApp Message Template

post

Deprecated: use POST /message_templates/{template_id} instead

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

whats_app_message_template_idstringRequired

WhatsApp Message Template ID

Body

application/jsontext/plain

objectOptional

Responses

200

Template updated successfully

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Template not found

application/json

500

Internal server error

application/json

post/v1/configs/templates/{whats_app_message_template_id}

HTTPcURLJavaScriptPython

POST /v1/configs/templates/{whats_app_message_template_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

application/jsontext/plain

{}

Deprecated

Compare Template

get

Deprecated: use GET /message_templates/:template_id/compare instead.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters

template_idstringRequired

Template ID

Responses

200

Template comparison completed successfully

application/json

Response payload containing template comparison results

categorystringOptionalExample: UTILITY

idstringOptionalExample: 594425479261596

languagestringOptionalExample: en_US

namestringOptionalExample: order_confirmation

statusstringOptionalExample: APPROVED

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/{template_id}/compare

HTTPcURLJavaScriptPython

GET /{template_id}/compare HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "category": "UTILITY",
  "compare": {
    "has_differences": true,
    "summary": "text"
  },
  "id": "594425479261596",
  "language": "en_US",
  "name": "order_confirmation",
  "status": "APPROVED"
}