Templates

Create a template

POST

/{phone_number_id}/templates

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.kirimdev.com/v1/106540352242922/templates"

  payload := strings.NewReader("{ \"name\": \"order_confirmation\", \"category\": \"MARKETING\", \"language\": \"en\", \"components\": [ { \"type\": \"HEADER\", \"format\": \"TEXT\", \"text\": \"example\", \"example\": { \"header_text\": [ \"example\" ], \"header_handle\": [ \"example\" ], \"header_url\": [ \"https://example.com\" ], \"body_text\": [ [ \"example\" ] ] }, \"buttons\": [ { \"type\": \"URL\", \"text\": \"example\", \"url\": \"https://example.com\", \"phone_number\": \"example\", \"otp_type\": \"COPY_CODE\", \"autofill_text\": \"example\", \"supported_apps\": [ { \"package_name\": \"example\", \"signature_hash\": \"example\" } ], \"example\": [ \"example\" ] } ], \"add_security_recommendation\": true, \"code_expiration_minutes\": 1 } ], \"variables\": [ \"example\" ], \"messageSendTtlSeconds\": 1 }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.kirimdev.com/v1/106540352242922/templates';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"order_confirmation","category":"MARKETING","language":"en","components":[{"type":"HEADER","format":"TEXT","text":"example","example":{"header_text":["example"],"header_handle":["example"],"header_url":["https://example.com"],"body_text":[["example"]]},"buttons":[{"type":"URL","text":"example","url":"https://example.com","phone_number":"example","otp_type":"COPY_CODE","autofill_text":"example","supported_apps":[{"package_name":"example","signature_hash":"example"}],"example":["example"]}],"add_security_recommendation":true,"code_expiration_minutes":1}],"variables":["example"],"messageSendTtlSeconds":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.kirimdev.com/v1/106540352242922/templates";

    let payload = json!({
        "name": "order_confirmation",
        "category": "MARKETING",
        "language": "en",
        "components": (
            json!({
                "type": "HEADER",
                "format": "TEXT",
                "text": "example",
                "example": json!({
                    "header_text": ("example"),
                    "header_handle": ("example"),
                    "header_url": ("https://example.com"),
                    "body_text": (("example"))
                }),
                "buttons": (
                    json!({
                        "type": "URL",
                        "text": "example",
                        "url": "https://example.com",
                        "phone_number": "example",
                        "otp_type": "COPY_CODE",
                        "autofill_text": "example",
                        "supported_apps": (
                            json!({
                                "package_name": "example",
                                "signature_hash": "example"
                            })
                        ),
                        "example": ("example")
                    })
                ),
                "add_security_recommendation": true,
                "code_expiration_minutes": 1
            })
        ),
        "variables": ("example"),
        "messageSendTtlSeconds": 1
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url https://api.kirimdev.com/v1/106540352242922/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "order_confirmation", "category": "MARKETING", "language": "en", "components": [ { "type": "HEADER", "format": "TEXT", "text": "example", "example": { "header_text": [ "example" ], "header_handle": [ "example" ], "header_url": [ "https://example.com" ], "body_text": [ [ "example" ] ] }, "buttons": [ { "type": "URL", "text": "example", "url": "https://example.com", "phone_number": "example", "otp_type": "COPY_CODE", "autofill_text": "example", "supported_apps": [ { "package_name": "example", "signature_hash": "example" } ], "example": [ "example" ] } ], "add_security_recommendation": true, "code_expiration_minutes": 1 } ], "variables": [ "example" ], "messageSendTtlSeconds": 1 }'

Create a new message template and submit it to Meta for review. The request body is components-only (mirrors Meta’s message_templates create shape). For IMAGE/VIDEO/DOCUMENT headers, supply example.header_url with a public https:// URL — Kirimdev uploads the sample to Meta on your behalf — or a Meta asset handle in example.header_handle. On success the template is persisted with status: "pending"; Meta reviews asynchronously, so poll GET /{phone_number_id}/templates/{name} (or re-run POST .../templates/sync) for the eventual approved / rejected transition. A duplicate name+language pair returns 409 template_already_exists.

Authorizations

bearerAuth

Parameters

Path Parameters

phone_number_id

required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

string

/^\d{6,20}$/

Example

106540352242922

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

Request Body

application/json

object

name

required

string

>= 1 characters <= 512 characters /^[a-z0-9_]+$/

Example

order_confirmation

category

required

string

Allowed values: MARKETING UTILITY AUTHENTICATION

Example

UTILITY

language

string

default: en >= 2 characters <= 10 characters /^[a-z]{2,3}(_[A-Z]{2})?$/

Example

id

components

required

Array<object>

>= 1 items

object

type

required

string

Allowed values: HEADER BODY FOOTER BUTTONS

format

string

Allowed values: TEXT IMAGE VIDEO DOCUMENT LOCATION

text

string

example

object

header_text

Array<string>

header_handle

Array<string>

header_url

Array<string>

body_text

Array<Array<string>>

buttons

Array<object>

object

type

required

string

Allowed values: URL PHONE_NUMBER QUICK_REPLY COPY_CODE OTP VOICE_CALL

text

string

>= 1 characters <= 25 characters

url

string format: uri

<= 2000 characters

phone_number

string

/^\+[1-9]\d{7,14}$/

otp_type

string

Allowed values: COPY_CODE ONE_TAP ZERO_TAP

autofill_text

string

supported_apps

Array<object>

object

package_name

required

string

signature_hash

required

string

example

Array<string>

add_security_recommendation

boolean

code_expiration_minutes

integer

>= 1 <= 60

variables

Array<string>

messageSendTtlSeconds

integer

>= 30 <= 2592000

Responses

200

Template created (pending Meta review)

application/json

object

data

required

object

required

string

object

required

string

Allowed values: template

name

required

string

language

required

string

status

required

string

Allowed values: pending approved rejected

content

required

string

variables

required

Array<string>

components

whatsapp_account

required

object

phone_number

required

string | null

phone_number_id

required

Meta business_phone_number_id — use as the {phone_number_id} path segment in /v1/{phone_number_id}/... endpoints.

string | null

customer

required

End-customer (multi-tenant platform mode) that owns this account. NULL for direct-org accounts.

object

required

string

name

required

string

provider_template_id

required

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

request_id

required

string

Example

{
  "data": {
    "id": "tmpl_01HXYZABCDEFGHJKMNPQRSTVWX",
    "object": "template",
    "status": "pending",
    "whatsapp_account": {
      "phone_number_id": "106540352242922",
      "customer": {
        "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    }
  }
}

400

Validation failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Authentication failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

404

Resource not found

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

409

Conflict (e.g. template already exists, webhook subscription disabled, setup link inactive)

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

422

Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Rate limit exceeded

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Internal server error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

502

Upstream WhatsApp error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}