Templates Management

Endpoints for managing WhatsApp message templates

Get templates

get

Use this endpoint to get templates. Filtering is available. Rate limits: This endpoint is subject to rate limits. A maximum of 400 total requests per minute is allowed. Requests exceeding these limits will receive a 429 Too Many Requests response.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

waba_account_idstringRequired

Internal 360dialog ID of the waba account. This ID always have postfix WA.

Example: exampleWA

Query parameters

limitintegerOptional

Maximum number of returned objects.

Example: 10

offsetintegerOptional

Number of objects to skip.

Example: 0

Responses

200

Successful response

application/json

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "filters": {
    "language": {
      "like": "en_"
    }
  },
  "sort": [
    "business_templates.name"
  ],
  "limit": 10,
  "offset": 0,
  "count": 1,
  "total": 1,
  "waba_templates": [
    {
      "modified_by": {
        "user_id": "user123U",
        "user_name": "John Doe"
      },
      "created_by": {
        "user_id": "user123U",
        "user_name": "John Doe"
      },
      "modified_at": "2023-01-02T12:00:00Z",
      "created_at": "2023-01-01T12:00:00Z",
      "category": "MARKETING",
      "components": [
        {
          "text": "Template message here.",
          "type": "BODY"
        }
      ],
      "language": "en_US",
      "name": "Template Example",
      "external_id": "23412223951120",
      "id": "exampleWT",
      "namespace": "12abcdefghijk_34lmnop",
      "partner_id": "examplePA",
      "quality_score": {
        "score": "YELLOW",
        "reasons": [
          "This message template is at risk of being disabled."
        ]
      },
      "rejected_reason": "INVALID_FORMAT",
      "status": "rejected",
      "waba_account_id": "exampleWA"
    }
  ]
}

Create a template

post

Use this endpoint to create a template. Rate limits: This endpoint is subject to rate limits. A maximum of 60 total requests per minute per waba id is allowed. Requests exceeding these limits will receive a 429 Too Many Requests response.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

waba_account_idstringRequired

Internal 360dialog ID of the waba account. This ID always have postfix WA.

Example: exampleWA

Body

application/json

categorystring · enum · nullableRequired

Template category.

Example: MARKETINGPossible values:

languagestring · enumRequired

Template language short code.

Example: en_USPossible values:

namestring · min: 1 · max: 512Required

Template name.

Example: Template Example

message_send_ttl_secondsintegerOptional

To override the default time-to-live when creating an authentication, utility and marketing templates

Example: 30

allow_category_changebooleanOptionalDeprecated

Allow Meta to auto-update template category

Example: true

cta_url_link_tracking_opted_outbooleanOptional

Opt in or opt out of button click analytics for the template

Example: true

Responses

200

Successful response

application/json

400

Wrong payload

application/json

404

Not found

application/json

429

Client error

application/json

post

/api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 769

{
  "category": "MARKETING",
  "components": [
    {
      "text": "Example text with {{1}} pattern",
      "type": "HEADER",
      "format": "VIDEO",
      "example": {
        "header_text": [
          "example"
        ],
        "header_handle": [
          "https://images.com/example.jpg"
        ],
        "header_text_named_params": [
          {
            "param_name": "title",
            "example": "Congratulations!"
          }
        ],
        "body_text": [
          [
            "some",
            "another"
          ]
        ],
        "body_text_named_params": [
          {
            "param_name": "customer_name",
            "example": "John Doe"
          }
        ]
      },
      "buttons": [
        {
          "type": "PHONE_NUMBER",
          "text": "Call",
          "phone_number": "15550051310"
        }
      ],
      "cards": [
        {
          "components": [
            "[Circular Reference]"
          ]
        }
      ],
      "limited_time_offer": {
        "text": "Offer here!",
        "has_expiration": true
      },
      "add_security_recommendation": true,
      "code_expiration_minutes": 1
    }
  ],
  "language": "en_US",
  "name": "Template Example",
  "message_send_ttl_seconds": 30,
  "cta_url_link_tracking_opted_out": true
}

{
  "modified_by": {
    "user_id": "user123U",
    "user_name": "John Doe"
  },
  "created_by": {
    "user_id": "user123U",
    "user_name": "John Doe"
  },
  "modified_at": "2023-01-02T12:00:00Z",
  "created_at": "2023-01-01T12:00:00Z",
  "category": "MARKETING",
  "components": [
    {
      "text": "Template message here.",
      "type": "BODY"
    }
  ],
  "language": "en_US",
  "name": "Template Example",
  "external_id": "23412223951120",
  "id": "exampleWT",
  "namespace": "12abcdefghijk_34lmnop",
  "partner_id": "examplePA",
  "quality_score": {
    "score": "YELLOW",
    "reasons": [
      "This message template is at risk of being disabled."
    ]
  },
  "rejected_reason": "INVALID_FORMAT",
  "status": "rejected",
  "waba_account_id": "exampleWA"
}

Migrate templates

post

Use this endpoint to move templates from one waba account to another (in the same business account). Useful for migrating between WABAs.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

waba_account_idstringRequired

Internal 360dialog ID of the waba account. This ID always have postfix WA.

Example: exampleWA

Body

application/json

source_waba_account_idstringRequired

Source WhatsApp Business Account ID to copy templates from

Example: 2388172987391

page_numberintegerOptional

This field specifies the index of which page of templates need to be migrated. Page 0 will migrate the first 2500 templates, and page 1 will migrate the next 2500 and so on.

Default: 0

Responses

200

Successful response

application/json

migrated_templatesstring[]Optional

List of template ids that successfully migrated.

Example: 147884035974987654

400

Wrong payload

application/json

404

Not found

application/json

503

Server error

application/json

post

/api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/migrate_templates

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/migrate_templates HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "source_waba_account_id": "2388172987391",
  "page_number": 0
}

{
  "migrated_templates": [
    "147884035974987654"
  ],
  "failed_templates": {
    "1016543234803242": "Incorrect category"
  }
}

Get template previews

get

Use this endpoint to generate previews of template texts in various languages. Currently only authentication templates are supported (use AUTHENTICATION as category parameter value). You can optionally include the security recommendation string and code expiration string.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

waba_account_idstringRequired

Internal 360dialog ID of the waba account. This ID always have postfix WA.

Example: exampleWA

Query parameters

categorystringOptional

The category of the template.

Example: AUTHENTICATION

languagesstringOptional

Comma-separated template languages to preview (e.g. en_US,es_US)

Example: en_US

add_security_recommendationbooleanOptional

The security recommendation.

Example: true

code_expiration_minutesintegerOptional

The code expiration minutes.

Example: 10

button_typesstringOptional

The button types.

Example: OTP

Responses

200

Successful response

application/json

bodystringRequired

The body of the template.

Example: *{{1}}* is your verification code. For your security, do not share this code.

footerstringRequired

The footer of the template.

Example: This code expires in 10 minutes.

languagestringRequired

The language of the template.

Example: en_US

400

Wrong payload

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/message_template_previews

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/message_template_previews HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "body": "*{{1}}* is your verification code. For your security, do not share this code.",
    "buttons": [
      {
        "autofill_text": "Autofill",
        "text": "Copy code"
      }
    ],
    "footer": "This code expires in 10 minutes.",
    "language": "en_US"
  }
]

Update a template

post

Use this endpoint to update a template. Rate limits: This endpoint is subject to rate limits. A maximum of 60 total requests per minute per waba id is allowed. Requests exceeding these limits will receive a 429 Too Many Requests response.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

waba_account_idstringRequired

Internal 360dialog ID of the waba account. This ID always have postfix WA.

Example: exampleWA

template_idstringRequired

The ID of the template.

Example: exampleWT

Body

application/json

categorystring · enum · nullableOptional

Template category.

Example: MARKETINGPossible values:

languagestring · enumOptional

Template language short code.

Example: en_USPossible values:

namestring · min: 1 · max: 512Optional

Template name.

Example: Template Example

message_send_ttl_secondsintegerOptional

To override the default time-to-live when creating an authentication, utility and marketing templates

Example: 30

allow_category_changebooleanOptionalDeprecated

Allow Meta to auto-update template category

Example: true

cta_url_link_tracking_opted_outbooleanOptional

Opt in or opt out of button click analytics for the template

Example: true

Responses

200

Successful response

application/json

400

Wrong payload

application/json

404

Not found

application/json

429

Client error

application/json

post

/api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates/{template_id}

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates/{template_id} HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "category": "MARKETING",
  "components": [
    {
      "text": "Template message here.",
      "type": "BODY"
    }
  ],
  "language": "en_US",
  "name": "Template Example",
  "message_send_ttl_seconds": 30,
  "cta_url_link_tracking_opted_out": true
}

{
  "modified_by": {
    "user_id": "user123U",
    "user_name": "John Doe"
  },
  "created_by": {
    "user_id": "user123U",
    "user_name": "John Doe"
  },
  "modified_at": "2023-01-02T12:00:00Z",
  "created_at": "2023-01-01T12:00:00Z",
  "category": "MARKETING",
  "components": [
    {
      "text": "Template message here.",
      "type": "BODY"
    }
  ],
  "language": "en_US",
  "name": "Template Example",
  "external_id": "23412223951120",
  "id": "exampleWT",
  "namespace": "12abcdefghijk_34lmnop",
  "partner_id": "examplePA",
  "quality_score": {
    "score": "YELLOW",
    "reasons": [
      "This message template is at risk of being disabled."
    ]
  },
  "rejected_reason": "INVALID_FORMAT",
  "status": "rejected",
  "waba_account_id": "exampleWA"
}

Delete a template

delete

Use this endpoint to delete a template by id.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

waba_account_idstringRequired

Internal 360dialog ID of the waba account. This ID always have postfix WA.

Example: exampleWA

template_idstringRequired

The ID of the template.

Example: exampleWT

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

409

Conflict

application/json

429

Client error

application/json

delete

/api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates/{template_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/partners/{partner_id}/waba_accounts/{waba_account_id}/waba_templates/{template_id} HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "developer_message": "template =`ExampleWT` was deleted",
    "http_code": 200,
    "success": true
  },
  "status_code": 200
}