Object

PropertyDescription
location_data
object
Contains location-specific data for the primary location associated with a site.

See the section below for details.
additional_locations
object
Contains location-specific data for any secondary/child locations associated with a site.

See the section below for details.
site_texts
object
Contains the standard and custom text strings. Each field has a max length of 4000 characters. There is a limit of 200 site_text per site.

See the section below for details.
business_data
object
Contains the name of the business, the primary logo_url and fields used to populate Duda's AI assistant.

See the section below for details.
site_images
object
Images that can be set and used within the design of the website. If you have the data, you should populate the alt value.

See the section below for details.

Location Specific Information

The following fields are related to a specific location in the content library.

location_data & additional_locations

PropertyDescription
phones
object[]
Contains phone numbers for this location. The object allows for a friendly label name and the actual phone number. Note that there is no specific requirement for phone numbers, Duda will display this in the same format you submit it in. Max 80 characters each.

See the section below for details.
emails
object[]
Contains all email addresses associated with this location. The object allows for a friendly label name and the actual email address. Max 80 characters each.

See the section below for details.
label
string
A simple name for this location. This is displayed in the Duda Content Library UI related to this location. Max 80 characters.
schema
object
Details of the location/organizational schema that's generated. Note: only available as a property for location_data, setting schema properties for additional_locations is not currently supported.
social_accounts
object
The profile name of this location's social networks. You must pass only the profile name/ID. Do not pass the full URL (e.g., https://wwwfacebook.com/duda). We support the following social networks: Facebook, Twitter, Yelp, Foursquare, Google Plus, Instagram, Youtube, Linkedin, Pinterest, Vimeo, RSS, Reddit, Trip Advisor & Snapchat.

See the section below for details.
address
object
Contains all fields required to display an address: streetAddress, postalCode, region, city, country.

See the section below for details.
address_geolocation
string
A geocode address string used to get LAT/LON from a geocoding map service. This is generated within the Duda Editor UI when searching for an address. Note: You can't update the geolocation string via the API (you can only read it).
geo
object
An object containing the LAT and LON of the address. Duda will return this if we've identified an address in the editor for this location, but we will not automatically generate it. You can pass this if you know the exact LAT/LON.
logo_url
string
A URL directly referencing the logo of this location. Must be a public URL and be served over HTTPS.
business_hours
object[]
An array containing each day of the week and the hours that the location opens and closes. For each set of hours, you can pass an array of days: MON, TUE, WED, THU, FRI, SAT, SUN that applies to those hours. Open and close hours must be in 24HH:MM format. So, for example, 7:30 am would be: 07:30 and 5 pm would be 17:00. If the business is closed on a certain day, please omit it from the data set. If the business is open 24 hours a day, you should pass the hours as 00:00 to 24:00.

See the section below for details.

phone

PropertyDescription
phoneNumber
string
A specific phone number.
label
string
A label to associate with the above phone number.

email

PropertyDescription
emailAddress
string
A specific email address.
label
string
A label to associate with the above email address.

schema

Property
type
string
The type of LocalBusinessSchema for this business. Full list of types can be found here.
custom_fields
array of objects
An array of objects with name and value properties for additional schema fields. This allows you to add any schema fields that Duda does not support via the content library data.

social_accounts

PropertyDescription
tripadvisor
string
A TripAdvisor page ID. Max 200 characters.
youtube
string
A YouTube page ID. Max 50 characters.
facebook
string
A Facebook page ID. Max 200 characters
yelp
string
A Yelp page ID. Max 300 characters
pinterest
string
A Pinterest page ID. Max 200 characters.
linkedin
string
A Linkedin page ID. Max 200 characters.
instagram
string
An Instagram page ID. Max 60 characters.
snapchat
string
A Snapchat page ID. Max 30 characters.
twitter
string
A Twitter/X page ID. Max 300 characters.
rss
string
A link to the site's RSS feed. Max 2048 characters.
vimeo
string
A Vimeo page ID. Max 200 characters
reddit
string
A Reddit page ID. Max 200 characters
foursquare
string
A Foursquare page ID. Max 200 characters
google_my_business
string
A Google Business ID. Max 200 characters
whatsapp
string
A WhatsApp ID. Max 50 characters
tiktok
string
A TikTok ID. Max 50 characters

address

PropertyDescription
streetAddress
string
The business's street address.
postalCode
string
The business's postal code.
region
string
The region where the business is located.
city
string
The city where the business is located.
country
string
The counter where the business is located.

geo

PropertyDescription
longitude
string
latitude
string

business_hours

PropertyDescription
days
string[]
[ "MON", "TUE", "WED", "THU", "FRI" ]
open
string
The time the business opens.
close
string
The time the business closes.

Global Properties

Below is website content that does not relate to a specific location. This is global data stored across the website.

PropertyDescription
business_data
object
Contains the name of the business, the primary logo_url and fields used to populate Duda's AI assistant. See the section below for details
site_texts
object
Containing overview, services, about_us and custom text strings. Each field has a max length of 4000 characters. There is a limit of 200 site_text per site. See the section below for details
site_images
object[]
Images that can be set and used within the design of the website. If you have the data, you should populate the alt value. See the section below for details

business_data

The business data object contains visible content for the site such as the name and logo of the business, and also contains data that is used by Duda's AI assistant to generate appropriate prompts

PropertyDescription
name
string
The name of the business. This field is required if you are also providing the AI assistant fields listed below.
logo_url
string
A URL to the overall business logo.
description
string
The description of the business. This field is used solely by the Duda AI Assistant to generate relevant prompts for AI content. Max 1000 characters
category
string
The category of the business. This field is used solely by the Duda AI Assistant to generate relevant prompts for AI content. Max 100 characters
service_area
string
The service area of the business. This field is used solely by the Duda AI Assistant to generate relevant prompts for AI content. Any description of a service area is allowed, and is not limited to a specific address. Max 200 characters
tone_of_voice
string enum
One of CONVERSATIONAL, HUMOROUS, ENTHUSIASTIC, INFORMATIVE, PROFESSIONAL, WITTY or AUTHORITATIVE. This field is used solely by the Duda AI Assistant to generate relevant prompts for AI content. Any other value outside of the enum will result in a parse error.

site_texts

PropertyDescription
overview
string
Overview of the business. Up to 4000 characters.
services
string
List of services. Up to 4000 characters.
about_us
string
About the business. Up to 4000 characters.
custom
object[]
An array of key/value pairs of custom text to be used as site content. Each object in the array consists of a label and text property.

site_images

PropertyDescription
label
string
Identifier for image in the content library. Used when connecting this image to widgets. Max 80 characters.
url
string
A URL to the image.
alt
string
A description of the image used by screen readers and other assistive technologies. Max 80 characters.

Example Payload

{
  "location_data":{
    "phones":[
      {
        "phoneNumber":"123-123-1234",
        "label":"Russ Phone"
      },
      {
        "phoneNumber":"18001234567",
        "label":"Duda Phone"
      }
    ],
    "emails":[
      {
        "emailAddress":"[email protected]",
        "label":"API Email"
      },
      {
        "emailAddress":"[email protected]",
        "label":"Support Email"
      }
    ],
    "schema": {
      "type": "Resort",
      "custom_fields":[
        {
          "name":"acceptsReservations",
          "value":true
        },
        {
          "name":"priceRange",
          "value":"$$$"
        }
      ]
    },
    "label":"Duda HQ",
    "social_accounts":{
      "tripadvisor":"Restaurant_Review-g32849-d2394400-Reviews-Oren_s_Hummus_Shop-Palo_Alto_California.html",
      "youtube":"UCPMwzOc1Su-s2z-J1xiU9ig",
      "facebook":"duda",
      "yelp":"orens-hummus-shop-palo-alto",
      "pinterest":"michelleobama",
      "google_plus":"+Dudamobile577",
      "linkedin":"duda",
      "instagram":"orenshummus",
      "snapchat":"michelleobama",
      "twitter":"dudamobile",
      "rss":"https://www.duda.co/blog/feed/",
      "vimeo":"dudamobile",
      "reddit":"duda"
    },
    "address":{
      "streetAddress":"577 College Ave",
      "postalCode":"94306",
      "region":"CA",
      "city":"Palo Alto",
      "country":"US"
    },
    "address_geolocation":"1833 Harvard St NW, Washington, DC 20009, USA",
    "geo":{
      "longitude":"-122.4757527166",
      "latitude":"37.502439189002"
    },
    "logo_url":"https://du-cdn.multiscreensite.com/duda_website/img/home/agencies.svg",
    "business_hours":[
      {
        "days":[
          "MON",
          "TUE",
          "WED",
          "THU",
          "FRI"
        ],
        "open":"09:00",
        "close":"18:00"
      }
    ]
  },
  "additional_locations":[
    {
      "uuid":"276169839",
      "phones":[
        {
          "phoneNumber":"123-123-1234",
          "label":""
        }
      ],
      "emails":[
        
      ],
      "label":"Duda Tel Aviv",
      "social_accounts":{
        
      },
      "address":{
        
      },
      "geo":{
        "longitude":"34.78337",
        "latitude":"32.07605"
      },
      "logo_url":null,
      "business_hours":null
    }
  ],
  "site_texts":{
    "overview":"Oh, Duda? Duda is a variation of \"Dude\", who just happens to be the main character in one of our favorite movies of all time: The Big Lebowski. You should watch it some time. Look out for that ferret!",
    "services":"- Responsive Website Builder",
    "custom":[
      {
        "label":"Example CTA 1",
        "text":"THE WEB DESIGN PLATFORM FOR Scaling Your Agency"
      },
      {
        "label":"Example CTA 2",
        "text":"THE WEB DESIGN PLATFORM FOR\nBuilding Websites Faster"
      }
    ],
    "about_us":"Duda is a leading website builder for web professionals and agencies of all sizes. Our website builder enables you to build amazing, feature-rich websites that are perfectly suited to desktop, tablet and mobile. Our mobile builder enables you to build mobile-only sites from scratch, or based on an existing desktop site or Facebook business page. Duda allows professionals and agencies to build high-converting, personalized websites at scale. Duda optimizes each and every site for Google PageSpeed."
  },
  "business_data":{
    "name":"Duda",
    "logo_url":"https://www.duda.co/developers/REST-API-Reference/images/duda.svg",
    "description": "A responsive website builder built for web professionals",
    "category": "Software",
    "service_area": "A 30 mile radius from Boulder, Colorado",
    "tone_of_voice": "CONVERSATIONAL"
  },
  "site_images":[
    {
      "label":"Example Store Logo",
      "url":"https://irt-cdn.multiscreensite.com/7536fe2010ed4f7ea68e21d0cb868e01/dms3rep/multi/ice_cream_logo_b_w-18-300x300.svg",
      "alt":"Example Store Logo"
    },
    {
      "label":"Example Store Banner",
      "url":"https://irt-cdn.multiscreensite.com/7536fe2010ed4f7ea68e21d0cb868e01/dms3rep/multi/sign_icecream_shop-1000x1108.jpg",
      "alt":"Example Store Banner"
    }
  ]
}