Templates

Fetch a single template by name

Fetch one message template owned by this WhatsApp account. Template names are not globally unique, so pass language when the account has multiple language variants with the same name.

get/{phone_number_id}/templates/{name}

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/templates/{name}
  • Auth: HTTP bearer

Path parameters

phone_number_idstring 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).

Example:106540352242922
namestring required

Meta template name, unique within an account and language variant.

Example:order_confirmation

Query parameters

languagestring

Select a specific language variant when several templates share the same name.

Example:id

Response

Template resource

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": {
    "id": "tmpl_01HXYZABCDEFGHJKMNPQRSTVWX",
    "category": "UTILITY",
    "whatsapp_account": {
      "phone_number_id": "106540352242922",
      "customer": {
        "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    }
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.