var zip = payload.zip;

const response = await axios.get(`https://app.zipcodebase.com/api/v1/search?apikey=YOUR-APIKEY&codes=${zip}&country=US`); // Insert your copied API key from Zipcodebase here.

console.log("Zipcodebase API response:", JSON.stringify(response.data, null, 2));

if (response.status === 200 && response.data.results && response.data.results[zip]) {
  const result = response.data.results[zip][0];

  payload.city = result.city || "City not available";
  payload.state = result.state || result.province || "State not available";
  payload.country_code = result.country_code || "Country code not available";
  payload.postal_code = result.postal_code || zip;
} else {
  payload.city = "City not available";
  payload.state = "State not available";
  payload.country_code = "Country code not available";
  payload.postal_code = zip;
}

In this example, we will demonstrate how to structure an automatic query using the Execute JavaScript functionality to consume the Zipcodebase API. The goal is to interact with the client, collect and validate the provided ZIP Code, perform the query, and deliver the corresponding address in a dynamic and automated way.

​
Example Using the Zipcodebase

  1. First, it is necessary to use the Conversation Created (WhatsApp) trigger in the automation and validate the response to save the provided ZIP Code value in the variable payload.zip.

  2. Once the ZIP Code is provided, our system automatically saves the received value (ZIP Code number) in the variable payload.zip.

  3. Next, we use Execute JavaScript to make a request to the Zipcodebase API and retrieve the corresponding address, as shown in the code below:

var zip = payload.zip;

const response = await axios.get(`https://app.zipcodebase.com/api/v1/search?apikey=YOUR-APIKEY&codes=${zip}&country=US`); // Insert your copied API key from Zipcodebase here.

console.log("Zipcodebase API response:", JSON.stringify(response.data, null, 2));

if (response.status === 200 && response.data.results && response.data.results[zip]) {
  const result = response.data.results[zip][0];

  payload.city = result.city || "City not available";
  payload.state = result.state || result.province || "State not available";
  payload.country_code = result.country_code || "Country code not available";
  payload.postal_code = result.postal_code || zip;
} else {
  payload.city = "City not available";
  payload.state = "State not available";
  payload.country_code = "Country code not available";
  payload.postal_code = zip;
}
  1. If the request fails, the code encounters issues, or the provided ZIP Code is incorrect, we can use Execute JavaScript to handle the error by creating an informative message with options to restart the query.

  1. If the request is successful, a confirmation message with the address corresponding to the ZIP Code will be sent. In this message, we also use button options to either direct the conversation to an agent or to finalize the confirmation process.

Observations:

  1. To learn more about the advanced settings of our WhatsApp messages, access our article in the help center: Understanding the Logic, Time, Chat, and Advanced Actions in Automations
  2. To learn more about structuring WhatsApp messages, automations, and using buttons, check out our tutorials:
  3. To check the Zipcodebase API, access the official documentation: https://zipcodebase.com/