INinfobip
channels
whatsapp
whatsapp-service-management
whatsapp-template-management

Create WhatsApp Template

Create a WhatsApp template. Created template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to template guidelines for additional info. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the latest version.

post/whatsapp/1/senders/{sender}/templates

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

senderstring required

Registered WhatsApp sender number. Must be in international format.

Request body

namestring required

Template name. Must only contain lowercase alphanumeric characters and underscores.

language'af' | 'sq' | 'ar' | 'ar_EG' | 'ar_AE' | 'ar_LB' | 'ar_MA' | 'ar_QA' | 'az' | 'bn' | 'bn_IN' | 'bg' | 'ca' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'hr' | 'cs' | 'da' | 'nl' | 'nl_BE' | 'en' | 'en_GB' | 'en_US' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GH' | 'en_IE' | 'en_IN' | 'en_JM' | 'en_MY' | 'en_NZ' | 'en_QA' | 'en_SG' | 'en_UG' | 'en_ZA' | 'et' | 'fil' | 'fi' | 'fr' | 'fr_BE' | 'fr_CA' | 'fr_CH' | 'fr_CI' | 'fr_MA' | 'ka' | 'de' | 'de_AT' | 'de_CH' | 'el' | 'gu' | 'ha' | 'he' | 'hi' | 'hu' | 'id' | 'ga' | 'it' | 'ja' | 'kn' | 'kk' | 'rw_RW' | 'ko' | 'ky_KG' | 'lo' | 'lv' | 'lt' | 'mk' | 'ms' | 'ml' | 'mr' | 'nb' | 'fa' | 'pl' | 'pt_BR' | 'pt_PT' | 'pa' | 'ro' | 'ru' | 'sr' | 'si_LK' | 'sk' | 'sl' | 'es' | 'es_AR' | 'es_CL' | 'es_CO' | 'es_CR' | 'es_DO' | 'es_EC' | 'es_HN' | 'es_MX' | 'es_PA' | 'es_PE' | 'es_ES' | 'es_UY' | 'sw' | 'sv' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'ur' | 'uz' | 'vi' | 'zu' | 'unknown' required

Template language, one template with same name can have multiple transliterations.

category'ACCOUNT_UPDATE' | 'PAYMENT_UPDATE' | 'PERSONAL_FINANCE_UPDATE' | 'SHIPPING_UPDATE' | 'RESERVATION_UPDATE' | 'ISSUE_RESOLUTION' | 'APPOINTMENT_UPDATE' | 'TRANSPORTATION_UPDATE' | 'TICKET_UPDATE' | 'ALERT_UPDATE' | 'AUTO_REPLY' required

All listed categories will be available until May 1, 2023.

Example request

{
  "language": "en",
  "category": "ACCOUNT_UPDATE",
  "structure": {
    "body": "body {{1}} content",
    "footer": "footer"
  }
}

Response

Template created.

idstring

Template ID.

businessAccountIdinteger

Business account ID to which template belongs.

namestring

Name of the template.

language'af' | 'sq' | 'ar' | 'ar_EG' | 'ar_AE' | 'ar_LB' | 'ar_MA' | 'ar_QA' | 'az' | 'bn' | 'bn_IN' | 'bg' | 'ca' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'hr' | 'cs' | 'da' | 'nl' | 'nl_BE' | 'en' | 'en_GB' | 'en_US' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GH' | 'en_IE' | 'en_IN' | 'en_JM' | 'en_MY' | 'en_NZ' | 'en_QA' | 'en_SG' | 'en_UG' | 'en_ZA' | 'et' | 'fil' | 'fi' | 'fr' | 'fr_BE' | 'fr_CA' | 'fr_CH' | 'fr_CI' | 'fr_MA' | 'ka' | 'de' | 'de_AT' | 'de_CH' | 'el' | 'gu' | 'ha' | 'he' | 'hi' | 'hu' | 'id' | 'ga' | 'it' | 'ja' | 'kn' | 'kk' | 'rw_RW' | 'ko' | 'ky_KG' | 'lo' | 'lv' | 'lt' | 'mk' | 'ms' | 'ml' | 'mr' | 'nb' | 'fa' | 'pl' | 'pt_BR' | 'pt_PT' | 'pa' | 'ro' | 'ru' | 'sr' | 'si_LK' | 'sk' | 'sl' | 'es' | 'es_AR' | 'es_CL' | 'es_CO' | 'es_CR' | 'es_DO' | 'es_EC' | 'es_HN' | 'es_MX' | 'es_PA' | 'es_PE' | 'es_ES' | 'es_UY' | 'sw' | 'sv' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'ur' | 'uz' | 'vi' | 'zu' | 'unknown'

Template language, one template with same name can have multiple transliterations.

status'APPROVED' | 'IN_APPEAL' | 'PENDING' | 'REJECTED' | 'PENDING_DELETION' | 'DELETED' | 'REINSTATED' | 'FLAGGED' | 'FIRST_PAUSED' | 'SECOND_PAUSED' | 'DISABLED' | 'ARCHIVED' | 'UNKNOWN'

Status of the template.

category'ACCOUNT_UPDATE' | 'PAYMENT_UPDATE' | 'PERSONAL_FINANCE_UPDATE' | 'SHIPPING_UPDATE' | 'RESERVATION_UPDATE' | 'ISSUE_RESOLUTION' | 'APPOINTMENT_UPDATE' | 'TRANSPORTATION_UPDATE' | 'TICKET_UPDATE' | 'ALERT_UPDATE' | 'AUTO_REPLY' | 'TRANSACTIONAL' | 'OTP' | 'MARKETING' | 'AUTHENTICATION' | 'UTILITY'

Category of the template.

Example response

{
  "id": "111",
  "businessAccountId": 222,
  "name": "template_name",
  "language": "en",
  "status": "APPROVED",
  "category": "ACCOUNT_UPDATE",
  "structure": {
    "body": "body {{1}} content",
    "footer": "footer"
  }
}

Changes

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