Marketing Messages

Endpoints for marketing message features

Get Dataset Quality

get

Retrieve dataset quality metrics and validation status for conversion tracking. Use the fields parameter to select specific metrics (e.g. web{event_match_quality,event_name}).

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

dataset_idstringRequired

Dataset (Pixel) ID to retrieve quality metrics for

agent_namestringOptional

Partner agent name to filter quality data by integration source

fieldsstringOptional

Fields to return, e.g. web{event_match_quality{composite_score,match_key_feedback{identifier,coverage}},event_coverage,dedupe_key_feedback,data_freshness,acr,event_name}

Responses

200

Dataset quality retrieved successfully

application/json

Response payload containing dataset quality metrics grouped by event source (web, etc.). Use the fields query parameter to select which metrics to return.

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Permissions error

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

get

/marketing/dataset_quality

HTTPcURLJavaScriptPython

GET /marketing/dataset_quality?dataset_id=text HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "web": [
    {
      "acr": {
        "description": "text",
        "percentage": 37.9
      },
      "data_freshness": {
        "description": "text",
        "upload_frequency": "real_time"
      },
      "dedupe_key_feedback": [
        {
          "browser_events_with_dedupe_key": {
            "description": "text",
            "percentage": 100
          },
          "dedupe_key": "event_id",
          "overall_browser_coverage_from_dedupe_key": {
            "description": "text",
            "percentage": 100
          },
          "server_events_with_dedupe_key": {
            "description": "text",
            "percentage": 100
          }
        }
      ],
      "event_coverage": {
        "description": "text",
        "goal_percentage": 75,
        "percentage": 34.1,
        "potential_aly_acr_increase": {
          "description": "text",
          "percentage": 37.9
        }
      },
      "event_match_quality": {
        "composite_score": 6.2,
        "diagnostics": [
          {
            "affected_event_count": 1,
            "description": "text",
            "name": "text",
            "percentage": 1,
            "solution": "text",
            "total_event_count": 1
          }
        ],
        "match_key_feedback": [
          {
            "coverage": {
              "description": "text",
              "percentage": 100
            },
            "identifier": "email",
            "potential_aly_acr_increase": {
              "description": "text",
              "percentage": 37.9
            }
          }
        ]
      },
      "event_name": "Purchase",
      "event_potential_aly_acr_increase": {
        "description": "text",
        "percentage": 37.9
      }
    }
  ]
}

Send Marketing Message (Alternative Route)

post

Alternative route for sending marketing messages via /marketing/marketing_messages endpoint. Used for template-based marketing messages.

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

objectOptional

or

Responses

200

Marketing message sent successfully

application/json

Response payload for a successfully sent marketing message

messaging_productstringOptionalExample: whatsapp

400

Bad request - Invalid request parameters

application/json

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Template not approved or insufficient permissions

application/json

500

Internal server error

application/json

post

/marketing/marketing_messages

HTTPcURLJavaScriptPython

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

{}

{
  "contacts": [
    {
      "input": "[phone]",
      "wa_id": "1234567890"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTIzNDU2Nzg5MA==",
      "message_status": "accepted"
    }
  ],
  "messaging_product": "whatsapp"
}

Get Message Templates

get

Retrieve list of WhatsApp message templates for a WhatsApp Business Account.

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

Response payload containing a paginated list of message templates for a WABA

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Permissions error

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

get

/marketing/message_templates

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "category": "UTILITY",
      "components": [
        {
          "add_security_recommendation": true,
          "buttons": [
            {
              "example": [
                "text"
              ],
              "phone_number": "text",
              "text": "text",
              "type": "QUICK_REPLY",
              "url": "text"
            }
          ],
          "code_expiration_minutes": 1,
          "example": {
            "body_text": [
              [
                "text"
              ]
            ],
            "header_handle": [
              "text"
            ],
            "header_text": [
              "text"
            ]
          },
          "format": "TEXT",
          "text": "text",
          "type": "HEADER"
        }
      ],
      "id": "594425479261596",
      "language": "en_US",
      "name": "order_confirmation",
      "status": "APPROVED"
    }
  ],
  "paging": {
    "cursors": {
      "after": "MjQZD",
      "before": "MAZDZD"
    }
  }
}

Get Template Analytics

get

Retrieve analytics data for message templates including delivery and engagement metrics.

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

objectOptional

Responses

200

Template analytics retrieved successfully

application/json

Response payload containing template analytics data

idstringOptionalExample: 1234567890

401

Unauthorized

application/json

500

Internal server error

application/json

get

/marketing/template_analytics

HTTPcURLJavaScriptPython

GET /marketing/template_analytics HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "1234567890",
  "template_analytics": [
    {
      "analytics": [
        {
          "data_points": [
            {
              "end": 1696204800,
              "start": 1696118400,
              "value": 120
            }
          ],
          "granularity": "DAILY",
          "metric_type": "delivered"
        }
      ],
      "template_id": "594425479261596"
    }
  ]
}

Enable Template Analytics

post

Enable analytics tracking for message templates. Requires enable=true query parameter.

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

enablestringRequired

Must be 'true' to enable analytics

Body

application/json

objectOptional

Responses

200

Template analytics enabled successfully

application/json

Response payload for successful analytics enablement

successbooleanOptionalExample: true

400

Bad request - enable=true required

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/marketing/template_analytics

HTTPcURLJavaScriptPython

POST /marketing/template_analytics?enable=text HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "success": true
}

Get Ad Object Insights

get

Retrieve insights and analytics data for a specific ad object (ad account, campaign, ad set, or ad). Returns performance metrics such as impressions, reach, spend, actions, and more.

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

ad_object_idstringRequired

Ad object ID (ad account, campaign, ad set, or ad)

Query parameters

fieldsstringOptional

Comma-separated list of fields to return, e.g. impressions,reach,spend,actions

date_presetstringOptional

Predefined date range, e.g. today, yesterday, last_7d, last_30d, lifetime

time_rangestringOptional

JSON time range object, e.g. {\

levelstringOptional

Aggregate level: account, campaign, adset, ad

filteringstringOptional

JSON array of filter objects, e.g. [{\

sortstringOptional

Sort order, e.g. reach_descending, impressions_ascending

breakdownsstringOptional

Comma-separated breakdowns, e.g. age,gender,country

action_breakdownsstringOptional

Comma-separated action breakdowns, e.g. action_type,action_device

action_attribution_windowsstringOptional

JSON array of attribution windows, e.g. ['1d_click','7d_click','1d_view']

use_unified_attribution_settingbooleanOptional

Use ad-set-level attribution settings to match Ads Manager behavior

limitintegerOptional

Maximum number of results to return

Responses

200

Ad object insights retrieved successfully

application/json

Response payload containing ad object analytics and insights data. Fields in each entry depend on the fields query parameter.

400

Bad request - ad_object_id required or invalid parameters

application/json

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Insufficient permissions (ads_read required)

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

get

/marketing/{ad_object_id}/insights

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "account_id": "act_123456",
      "actions": [
        {
          "1d_click": "6510",
          "1d_view": "86",
          "action_type": "link_click",
          "value": "6608"
        }
      ],
      "ad_id": "6142546123068",
      "adset_id": "6042542123468",
      "campaign_id": "6042542123268",
      "clicks": "1520",
      "cost_per_action_type": [
        {
          "1d_click": "6510",
          "1d_view": "86",
          "action_type": "link_click",
          "value": "6608"
        }
      ],
      "cost_per_unique_click": "1.96",
      "cpc": "1.55",
      "cpm": "0.81",
      "ctr": "0.062",
      "date_start": "2024-01-01",
      "date_stop": "2024-01-31",
      "frequency": "1.5",
      "impressions": "2466376",
      "reach": "10742",
      "spend": "2352.45",
      "unique_clicks": "1200"
    }
  ],
  "paging": {
    "cursors": {
      "after": "MjQZD",
      "before": "MAZDZD"
    }
  }
}

Get Conversion Dataset

get

Retrieve conversion dataset information for a Meta node (business account).

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

meta_node_idstringRequired

Meta node ID

Responses

200

Conversion dataset retrieved successfully

application/json

Response payload for conversion dataset operations. The returned id is the dataset_id used for sending events via the Conversions API.

idstringOptionalExample: 1234567890

namestringOptionalExample: my_dataset

400

Bad request - Invalid parameters or meta_node_id required

application/json

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Permissions error

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

get

/marketing/{meta_node_id}/dataset

HTTPcURLJavaScriptPython

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

{
  "id": "1234567890",
  "name": "my_dataset"
}

Post Conversion Dataset

post

Create or retrieve a conversion dataset for business messaging. Use the relevant business account ID as meta_node_id (e.g., WhatsApp Business Account ID).

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

meta_node_idstringRequired

Meta node ID

Body

application/json

objectOptional

or

Responses

200

Conversion dataset posted successfully

application/json

Response payload for conversion dataset operations. The returned id is the dataset_id used for sending events via the Conversions API.

idstringOptionalExample: 1234567890

namestringOptionalExample: my_dataset

400

Bad request - Invalid parameters or meta_node_id required

application/json

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Permissions error

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

post

/marketing/{meta_node_id}/dataset

HTTPcURLJavaScriptPython

POST /marketing/{meta_node_id}/dataset HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "1234567890",
  "name": "my_dataset"
}

Post Conversion Events

post

Send Conversions API events for business messaging using a dataset ID. Include data with event_name, event_time, action_source=business_messaging, messaging_channel, and user_data (for WhatsApp include whatsapp_business_account_id and ctwa_clid).

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

meta_node_idstringRequired

Meta node ID

Body

application/json

objectOptional

or

Responses

200

Conversion events posted successfully

application/json

Response payload for successfully posted conversion events

events_receivedintegerOptionalExample: 2

fbtrace_idstringOptionalExample: AbCdEfGhIjK

messagesstring[]Optional

400

Bad request - Invalid parameters or meta_node_id required

application/json

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Permissions error

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

post

/marketing/{meta_node_id}/events

HTTPcURLJavaScriptPython

POST /marketing/{meta_node_id}/events HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "events_received": 2,
  "fbtrace_id": "AbCdEfGhIjK",
  "messages": [
    "text"
  ]
}

Get Message Template

get

Retrieve a specific WhatsApp message template by template ID.

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 retrieved successfully

application/json

Response payload containing template details

categorystringOptionalExample: UTILITY

idstringOptionalExample: 594425479261596

languagestringOptionalExample: en_US

namestringOptionalExample: order_confirmation

statusstringOptionalExample: APPROVED

400

Bad request - Invalid parameter

application/json

401

Unauthorized - Invalid or missing access token

application/json

403

Forbidden - Permissions error

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Internal server error

application/json

get

/marketing/{template_id}

HTTPcURLJavaScriptPython

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

{
  "category": "UTILITY",
  "components": [
    {
      "add_security_recommendation": true,
      "buttons": [
        {
          "example": [
            "text"
          ],
          "phone_number": "text",
          "text": "text",
          "type": "QUICK_REPLY",
          "url": "text"
        }
      ],
      "code_expiration_minutes": 1,
      "example": {
        "body_text": [
          [
            "text"
          ]
        ],
        "header_handle": [
          "text"
        ],
        "header_text": [
          "text"
        ]
      },
      "format": "TEXT",
      "text": "text",
      "type": "HEADER"
    }
  ],
  "id": "594425479261596",
  "language": "en_US",
  "name": "order_confirmation",
  "status": "APPROVED"
}

Send Marketing Message

post

Send a marketing message via the marketing messages endpoint. Used for template-based marketing messages.

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

objectOptional

or

Responses

200

Marketing message sent successfully

application/json

Response payload for a successfully sent marketing message

messaging_productstringOptionalExample: whatsapp

400

Bad request - Invalid request parameters

application/json

401

Unauthorized - Invalid or missing D360-API-KEY

application/json

403

Forbidden - Template not approved or insufficient permissions

application/json

500

Internal server error

application/json

post

/marketing_messages

HTTPcURLJavaScriptPython

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

{}

{
  "contacts": [
    {
      "input": "[phone]",
      "wa_id": "1234567890"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTIzNDU2Nzg5MA==",
      "message_status": "accepted"
    }
  ],
  "messaging_product": "whatsapp"
}