One-Tap Autofill Authentication Templates
One-tap autofill authentication templates allow you to send a one-time password or code along with an one-tap autofill button to your users. When a WhatsApp user taps the autofill button, the WhatsApp client triggers an activity which opens your app and delivers it the password or code.
One-tap autofill button authentication templates consist of:
Preset text: <VERIFICATION_CODE> is your verification code.
An optional security disclaimer: For your security, do not share this code.
An optional expiration warning (optional): This code expires in <NUM_MINUTES> minutes.
A one-tap autofill button.
One-tap autofill buttons are only supported on Android. If you send an authentication template to a WhatsApp user who is using a non-Android device, the WhatsApp client will display a copy code button instead. URLs, media, and emojis are not supported.
Template Creation
You can use the WABA API to create One-tap autofill authentication templates. Alternatively, users can also create it using the WhatsApp Business Manager.
In the API
Use the create template endpoint and assemble the components in the request:
The base-url should be https://waba-v2.360dialog.io
for Cloud API and https://waba.360dialog.io
for On-Premise.
If you are using On-Premise API, remember that it is being discontinued by Meta. No new signups will be allowed with this type of integration from May 15, 2024.
Numbers registered before this date will still be supported, but should start planning a change of hosting type as soon as possible.
POST
[base-url]/v1/configs/templates
The message template name field is limited to 512 characters. The message template content field is limited to 1024 characters.
Headers
Name | Type | Description |
---|---|---|
D360-API-KEY | string |
Request Body
Name | Type | Description |
---|---|---|
name* | string | |
components* | array[objects] | Array of objects that describe the components that make up the template. |
category* | string | Allowed values: |
language* | string |
Upon success, the API will respond with a JSON object describing the newly created template.
Post Body
Note that in your template creation request the button type is designated as otp
, but upon creation the button type will be set to url
. You can confirm this by performing a GET request on a newly created authentication template and analyzing its components.
Properties
Placeholder | Description | Example Value |
---|---|---|
String | Optional.
One-tap autofill button label text.
Maximum 25 characters.
If omitted, the autofill text will default to a pre-set value, localized to the template's language. For example, |
|
Integer | Optional.
Indicates the number of minutes the password or code is valid.
If included, the code expiration warning and this value will be displayed in the delivered message. The button will be disabled in the delivered message the indicated number of minutes from when the message was sent.
If omitted, the code expiration warning will not be displayed in the delivered message. In addition, the button will be disabled 10 minutes from when the message was sent.
Minimum 1, maximum 90. |
|
String | Optional.
Copy code button label text.
If omitted, the text will default to a pre-set value localized to the template's language. For example,
If included, the authentication template message will display a copy code button with this text if the message fails the eligibility check.
Maximum 25 characters. |
|
String | Required.
Your Android app's package name. |
|
Boolean | Optional.
Set to |
|
String |
| |
String |
| |
String | Required.
Template name.
Maximum 512 characters. |
|
Integer |
|
Example Request
This example creates a template named "authentication_code_autofill_button" categorized as authentication
with all optional text strings enabled and a one-tap autofill button.
Example Response
Sending One-Tap Autofill Authentication Templates
See our Authentication Templates documentation to learn how to send it to customers.
Last updated