Create a template

Creates a template and, with submit: true, submits it to Meta for review. Names must be lowercase snake case and unique per language.

Required scope: templates:write

POST /v1/templates

Create a template

cURL

curl --request POST \
  --url https://lazyapp.in/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "language": "<string>",
  "body_text": "<string>",
  "body_examples": [
    "<string>"
  ],
  "footer_text": "<string>",
  "header": {
    "text": "<string>",
    "examples": [
      "<string>"
    ],
    "example_handle": "<string>",
    "example_url": "<string>"
  },
  "buttons": [
    {
      "text": "<string>",
      "url": "<string>",
      "examples": [
        "<string>"
      ],
      "example": "<string>",
      "phone_number": "<string>",
      "flow_id": "<string>",
      "ttl_minutes": 22320,
      "app_deep_link": {
        "android_deep_link": "<string>",
        "android_fallback_playstore_url": "<string>"
      }
    }
  ],
  "submit": true,
  "library_template_name": "<string>",
  "limited_time_offer": {
    "text": "<string>",
    "has_expiration": true
  },
  "authentication": {
    "add_security_recommendation": true,
    "code_expiration_minutes": 45
  },
  "carousel_cards": [
    {
      "example_handle": "<string>",
      "body_text": "<string>",
      "buttons": [
        {
          "text": "<string>",
          "url": "<string>",
          "examples": [
            "<string>"
          ],
          "phone_number": "<string>"
        }
      ],
      "example_url": "<string>"
    }
  ],
  "message_send_ttl_seconds": 1295999,
  "call_permission_request": true,
  "cta_url_link_tracking_opted_out": true,
  "creative_features": {},
  "max_price": {
    "bid_amount": 2,
    "country_multipliers": {}
  }
}
'

201

{
  "uuid": "<string>",
  "name": "<string>",
  "language": "<string>",
  "category": "AUTHENTICATION",
  "status": "draft",
  "body_text": "<string>",
  "body_examples": [
    "<string>"
  ],
  "header": {},
  "footer_text": "<string>",
  "buttons": [
    {
      "type": "QUICK_REPLY",
      "text": "<string>",
      "url": "<string>",
      "examples": [
        "<string>"
      ],
      "example": "<string>",
      "phone_number": "<string>",
      "flow_id": "<string>",
      "ttl_minutes": 22320,
      "app_deep_link": {
        "android_deep_link": "<string>",
        "android_fallback_playstore_url": "<string>"
      }
    }
  ],
  "rejection_reason": "<string>",
  "quality_score": "<string>",
  "provider_template_id": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "carousel_cards": [
    {
      "header_format": "IMAGE",
      "example_handle": "<string>",
      "body_text": "<string>",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "<string>",
          "url": "<string>",
          "examples": [
            "<string>"
          ],
          "phone_number": "<string>"
        }
      ]
    }
  ],
  "limited_time_offer": {},
  "call_permission_request": true,
  "message_send_ttl_seconds": 123,
  "cta_url_link_tracking_opted_out": true,
  "marketing_options": {},
  "source": "<string>",
  "sub_category": "<string>",
  "pending_category": "<string>",
  "template_group": "<string>",
  "send_features": [
    {}
  ],
  "rejection_reason_text": "<string>"
}

Authorizations

Authorization · string · header · required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key · string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json

body_text is required unless library_template_name is set.

name · string · required

Maximum string length: 512

Pattern: ^[a-z0-9_]+$

language · string · required

Maximum string length: 16

category · enum<string> · required

Available options: AUTHENTICATION, UTILITY, MARKETING

body_text · string

Use {{1}}-style placeholders.

Maximum string length: 1024

body_examples · string[]

Maximum array length: 50

Maximum string length: 255

footer_text · string

Maximum string length: 60

header · object

Show child attributes

buttons · object[]

Maximum array length: 10

Show child attributes

submit · boolean

Submit to Meta immediately.

parameter_format · enum<string>

NAMED uses {{first_name}}-style variables.

Available options: POSITIONAL, NAMED

library_template_name · string

Clone a ready-made template from GET /v1/templates/library instead of writing body_text.

Maximum string length: 512

Pattern: ^[a-z0-9_]+$

limited_time_offer · object

Show child attributes

authentication · object

Show child attributes

carousel_cards · object[]

Media carousels take 2 to 10 cards; product carousels exactly 2 when created. Every card has the same button types.

Maximum array length: 10

Show child attributes

message_send_ttl_seconds · integer

How long WhatsApp keeps trying to deliver. Authentication 30–900, utility 30–43200, marketing 43200–2592000. -1 means 30 days (authentication and utility only).

Required range: -1 <= x <= 2592000

call_permission_request · boolean

Marketing or utility: ask the customer for permission to call them. Body only, no buttons.

cta_url_link_tracking_opted_out · boolean

Marketing: turn off Meta's click tracking for URL buttons.

creative_features · object

Marketing: Meta's automatic creative improvements, such as image_animation or add_text_overlay.

Show child attributes

max_price · object

Marketing only, after the max price agreement is accepted. Clear it by sending null for both fields.

Show child attributes

Response

201

application/json

Created.

uuid · string

name · string

language · string

category · enum<string>

Available options: AUTHENTICATION, UTILITY, MARKETING

status · enum<string>

Available options: draft, submitting, pending, approved, rejected, paused, disabled, archived, deleted

body_text · string

body_examples · string[]

header · object

footer_text · string | null

buttons · object[]

Show child attributes

rejection_reason · string | null

quality_score · string | null

provider_template_id · string | null

submitted_at · string<date-time> | null

approved_at · string<date-time> | null

created_at · string<date-time> | null

carousel_cards · object[]

Show child attributes

limited_time_offer · object | null

call_permission_request · boolean

message_send_ttl_seconds · integer | null

cta_url_link_tracking_opted_out · boolean | null

marketing_options · object | null

Creative features and max price as last submitted.

source · string | null

Set when Meta generated the template (for example from Direct Send). Such templates cannot be edited or deleted here.

sub_category · string | null

pending_category · string | null

The category Meta will move this template to.

template_group · string | null

uuid of the template group.

send_features · object[]

Extra inputs a send needs, such as cards, coupon_code or voice_call.

rejection_reason_text · string | null