Locations Data

Update Several Locations

Make changes to a list of locations. Any blank parameter deletes an old value, any unspecified parameter does nothing

Caution! Changing the Location Name, Country, Street, ZIP, City, Province, Phone Number, or Primary Business Category may cause your listings to become unverified on Google, which could temporarily impact your visibility.

patch/locations

Request

Base URL
https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
Auth
HTTP bearer

Request body /

idinteger

Output only. The PromoRepublic unique id for the location

namestring required

The location's name

streetstring required

The location's street address

streetNostring nullable

The location's street number

Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION

addressExtrastring nullable

An address extra: e.g. building, floor...

zipstring nullable

Zip code, optional only for some countries.

citystring required

City

provincestring nullable

Province. Only send when not blank

country'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UK' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' required

Country of the location

latnumber double nullable

The latitude coordinate of the location

lngnumber double nullable

The longitude coordinate of the location

addressDisplayboolean

Indicates if the address should be displayed or hidden

phonestring nullable

The location's contact phone number, a valid phone number has to be provided.

faxstring nullable

The location fax number

cellphonestring nullable

A contact mobile phone number

websitestring nullable

A valid url for the location's website (use UTMs to add tracking)

emailstring nullable

A contact email for the location

legalIdentstring nullable

A legal identifier of the location. SIRET number in France

taxNumberstring nullable

The tax number of the location. CIF/NIF in Spain

emailVerification'UNVERIFIED' | 'VERIFIED' nullable

The locations verification status

descriptionShortstring nullable

A short description - up to 200 characters, all characters must match this regexp:

[0-9\p'{'L'}'\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€£$]

descriptionLongstring nullable

A long description - up to 1000 characters, all characters must match this regexp:

[0-9\p'{'L'}'\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²³`´·"'\+¡¿@°€\^£$]

imprintstring nullable

The imprint of the location

openingHoursNotesstring nullable

Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters, all characters must match this regexp:

[0-9\p'{'L'}'\(\)\[\] \?:;\/!\\,\.\-%\\&\r\n\t_\*§²`´·"'\+¡¿@]

keywordsstring[] nullable

Keywords describing the location's activity

brandsstring[] nullable

The brands offered by the location to its customers

paymentOptionsstring[] nullable

The payment options accepted at the location. To remove a specific option, prefix its value with '-' (e.g. ["-cash"] removes the 'cash' option). Sending the full list replaces all options.

languagesstring[] nullable

The language(s) in which customers can interact with the location's staff

alternativeNamesstring[] nullable

Alternative names for the location. Output only for public API.

categoriesinteger[]

Required to start location sync - A list of category IDs describing the location

The status of the location. One of:

<ul><li>ACTIVE - will be synced and renewed</li> <li>INACTIVE - will not be synced anymore, claims of listings will be released where possible</li> <li>CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE</li> <li>CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported</li></ul>

firstSyncStartedstring date-time nullable

Output only. Date and time when the first sync was started for the location. Set together with lastSyncStarted; either both fields are populated or both are null.

lastSyncStartedstring date-time nullable

Output only. Date of the last sync for the location

lastSyncCheckEnqueuedstring date-time nullable

Output only. Date and time when a sync check was last enqueued

lastUnwantedCheckEnqueuedstring date-time nullable

Output only. Date and time when a duplicate check was last enqueued

deactivatedstring date-time nullable

Output only. Date and time when the location was deactivated (status INACTIVE or CLOSED)

identifierstring nullable

The location identifier based on your internal identification system

nextBillingstring date-time nullable

Output only. Next billing date for the location

endDatestring date-time nullable

Subscription/contract end date for this location. When set, indicates the date on which the location's subscription is scheduled to end. Distinct from cancellationDate (which records when a cancellation was requested). Nullable.

cancellationDatestring date-time nullable

Output only. Cancellation date for the location

dateCreatedstring date-time nullable

Output only. The date and time the location was created in our database

lastUpdatedstring date-time nullable

Output only. Date of the last changes made to the location. Includes updates by users, API, location cleansing, and duplicate checks

autoSyncboolean

When autosync is set to true, information changed for the location in PromoRepublic will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.

timezonestring nullable

The location's timezone

openingDatestring date nullable

The date the location will first open. Must be formatted YYYY-MM-DD

sortableDatastring nullable

Internal field for sorting and search data optimization.

wizardStepFinishedinteger nullable

Output only. Last step finished in the creation wizard.

featuresstring[]

Output only. List of features available to the location

streetAndNumberstring

Combined street address and street number as a single string (e.g. "Main St 42" or "42 Main St" depending on the country's convention). In responses, this field is always populated from the stored 'street' and 'streetNo' values. In create/update requests, 'streetAndNumber' can be used as an alternative to sending separate 'street' and 'streetNo' fields — useful when only a combined "Address Line 1" value is available. When provided, the system attempts to automatically extract the street number from the combined value.

If 'street' or 'streetNo' is also present in the same request, 'streetAndNumber' is ignored.

businessNamestring

nameDescriptorstring

An addition to the location's name which gives specific info about the location's address (e.g. Mall level 2 OR Inside Departures). Sent only to FACEBOOK

sublocalitystring

skipGeoCodingboolean

Marks this location so address normalization/geocoding is skipped. Read/write only - has no effect on its own; setting it does not change any address field and does not trigger normalization or cleansing. Absent and explicit false are the same state.

businessSyncableboolean

activeDirectoriesCountinteger

Output only. Number of active directories

activeListingsCountinteger

Output only. Number of active listings

businessIdinteger

ID of the business this location is linked to. Mandatory when creating a location. Sending a different ID than the current businessId when updating will lead to changing the business. This is only possible in case all connected accounts (Facebook, Google, …) are compatible.

cleansingComment'ADDRESS_DETAILS_VERIFIED' | 'NAME_ADDRESS_DETAILS_UPDATED' | 'NON_CLOSURE_CONFIRMATION'

Cleansing comment by user, set only when cleansingStatus is INVALID_DATA. Possible Values (ADDRESS_DETAILS_VERIFIED, NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)

cleansingInvalidDataReasonstring

Output only. Invalid Cleansing Reason (eg. INCOMPLETE_ADDRESS,ADDRESS_ IS_PO_BOX,ADDRESS_ DOES_NOT_EXIST, LOCATION_IS_CLOSED, INFORMATION_IS_WRONG, LOCATION_IS_MOVED, NON_LATIN_CHARACTERS_ADDRESS, OTHER). Guide on how to fix invalid data issues - http://ubr.al/fix_invalid_data

cleansingStatus'NOT_CLEANSED' | 'PENDING' | 'CLEANSED' | 'INVALID_DATA'

Output only. Current cleansing status for the location. Possible values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA

contentListsinteger[]

The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the location

dataPointsinteger

Output only. Number of dataPoints (reviews, photos) left by users at this location

listingsBeingUpdatedinteger

Output only. Number of listings still being updated

averageRatingnumber double

listingsInSyncinteger

Output only. The number of listings in sync

missingMandatoryFieldsstring[]

Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]

directoriesMissingConnectstring[]

directoriesPublishingStatusstring[]

locationSyncableboolean

suggestionsForFieldsAvailableboolean

profileCompletenessinteger

Output only. Number representing completeness of location data, up to 100

publishedListingsCountinteger

Output only. Number of published listings

visibilityIndexinteger

Output only. The location's latest visibility index

skipFacebookPicturesUpdateboolean

When set to true, PromoRepublic will skip publishing any photos to Facebook for this location. This affects both sync checks and updates.

businessCountry'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UK' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW'

businessType'SMB' | 'ENTERPRISE'

Example request

[
  {
    "openingHours": [
      {
        "dayOfWeek": 1,
        "closed": false,
        "from1": "08:00",
        "to1": "11:00"
      },
      {
        "dayOfWeek": 2,
        "closed": false,
        "from1": "08:00",
        "to1": "11:00",
        "from2": "13:00",
        "to2": "21:00"
      },
      {
        "dayOfWeek": 3,
        "closed": true
      }
    ],
    "specialOpeningHours": [
      {
        "date": "2017-06-29",
        "closed": true
      },
      {
        "date": "2017-06-30",
        "from1": "11:00",
        "to1": "14:00",
        "from2": "16:00",
        "to2": "20:00"
      }
    ],
    "name": "Coffee House Berlin",
    "street": "Friedrichstraße",
    "streetNo": "45A",
    "addressExtra": "Suite 304",
    "zip": "10115",
    "city": "Berlin",
    "province": "Berlin",
    "country": "DE",
    "lat": 52.52,
    "lng": 13.405,
    "addressDisplay": true,
    "phone": "+4912345678",
    "fax": "+4912345678",
    "cellphone": "+4912345678",
    "website": "https://www.example.com",
    "email": "info@example.com",
    "openingHoursNotes": "We never open on bank holidays",
    "paymentOptions": [
      "-cash",
      "credit card",
      "invoice"
    ],
    "serviceAreas": [
      {
        "name": "Berlin, Deutschland",
        "placeId": "ChIJAVkDPzdOqEcRcDteW0YgIQQ"
      }
    ],
    "doctorComData": {
      "doctorCategoriesDetailed": [
        {
          "id": 111,
          "nuccTaxonomyCode": "207RI0011X"
        }
      ]
    },
    "customFields": [
      {
        "name": "foo",
        "value": "bar"
      }
    ],
    "attributes": [
      {
        "valueType": "BOOL, URL, ENUM, REPEATED_ENUM"
      }
    ],
    "businessId": 1234,
    "linkedToLocationGroups": [
      {
        "locations": [
          {
            "id": 1,
            "name": "Location 1",
            "status": "ACTIVE"
          }
        ],
        "users": [
          {
            "id": 1,
            "email": "jane.doe@example.com",
            "firstName": "Jan",
            "lastName": "Didschuneit",
            "role": "ADMIN",
            "status": "VERIFIED"
          }
        ]
      }
    ],
    "locatedIn": [
      {
        "placeId": "ChIJAVkDPzdOqEcRcDteW0YgIQQ",
        "relationType": "DEPARTMENT_OF",
        "lat": 52.52,
        "lng": 13.405
      }
    ],
    "moreHours": [
      {
        "hours": [
          {
            "dayOfWeek": 1,
            "from": "08:00",
            "to": "18:00"
          }
        ]
      }
    ],
    "skipFacebookPicturesUpdate": true,
    "contentCollections": {
      "contentLists": [
        {
          "title": "Lunch Menu",
          "items": [
            {
              "category": "Starters, Drinks, Desert, etc."
            }
          ]
        }
      ]
    },
    "services": [
      {
        "currency": "USD"
      }
    ]
  }
]

Response

Locations successfully updated

messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "updatedCount": 10,
    "failedCount": 2,
    "missingIdCount": 1
  }
}

Changes

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