Object

Property

Description

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 2000 characters.

See the section below for details.

business_data
object

Contains the name of the business and the primary image logo_url of the website.

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_data & additional_locations

Property

Description

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.

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

Property

Description

phoneNumber
string

A specific phone number.

label
string

A label to associate with the above phone number.

email

Property

Description

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 for additional schema fields. This allows you to add any schema fields that Duda does not support via the content library data.

social_accounts

Property

Description

tripadvisor
string

A link to the site's TripAdvisor page.

youtube
string

A link to the site's YouTube page.

facebook
string

A link to the site's Facebook page.

yelp
string

A link to the site's Yelp page.

pinterest
string

A link to the site's Pinterest page.

google_plus
string

A link to the site's Google Plus page.

linkedin
string

A link to the site's Linkedin page.

instagram
string

A link to the site's Instagram page.

snapchat
string

A link to the site's Snapchat page.

twitter
string

A link to the site's Twitter page.

rss
string

A link to the site's RSS feed.

vimeo
string

A link to the site's Vimeo page.

reddit
string

A link to the site's Reddit page.

address

Property

Description

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

Property

Description

longitude
string

latitude
string

business_hours

Property

Description

days
string[]

[ "MON", "TUE", "WED", "THU", "FRI" ]

open
string

The time the business opens.

close
string

The time the business closes.

Global Properties Returned

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

Property

Description

site_texts
object

Containing overview, services, about_us and custom text strings. Each field has a max length of 2000 characters.

custom
object[]

An array that contains custom text strings. These will each have a label & text associated with them. These can be used for storing site data or information about the business.

business_data
object

Set the name of the business and the primary image logo_url of the website.

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.

{
  "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"
  },
  "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"
    }
  ]
}