--- title: "Update business location" method: POST path: "/locations/update" tags: ["Locations"] --- # Update business location `POST /locations/update` ## Request - Base URL: `https://api.synup.com/api/v4` - URL: `https://api.synup.com/api/v4/locations/update` - Auth: none required - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Update Location This API allows you to modify the attributes of an existing location within your account. It enables businesses to keep their location data up to date by updating key details such as address, contact information, business hours, categories, and other metadata. :::info [] **Processing Time for Location Updates** Updates to location attributes including `enabledSiteIds` or `submissionDisabledSiteIds`, are processed asynchronously before they are accurately reflected across all publishers and within the system. Allow this time for updates to be reflected accurately. ::: ## Headers - `Authorization` string, required ## Request body - object - `input` object, required - `id` string, required: Unique identifier in Base64 encoded format. Must be in the format `Location:` - `name` string: Name of the business - `archived` boolean: Indicates if the location is archived. Read-only. - `archivedAt` string, date-time, nullable: Timestamp when the location was archived. Read-only. - `billingPeriod` string, nullable: Billing cycle period. Read-only. - `bizUrl` string: URL of the business website - `bookingUrl` unknown - `businessHours` object[]: Business hours for each day of the week - `day` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' | 'SPECIAL', required: Day of the week | Special - `slots` object[], required: Array of time slots (minimum 1, maximum 2). Required only if type is OPEN. - `start` string: Opening time. Valid formats: `:am` OR `:pm` - `end` string: Closing time. Valid formats: `:am` OR `:pm` - `type` 'OPEN' | 'OPEN_24x7' | 'CLOSED', required: Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7) - `specialDate` string: Day should be `SPECIAL`. Regular hours is mandatory. **Regular hours is mandatory for special hours to be allowed ** - `city` string: City where the business is located - `countryIso` string: Country ISO code. Refer to the Places API for valid ISOs. - `customAttributes` object[] - `archived` boolean - `enumValues` string[] - `name` string - `slug` string - `type` string - `value` string[] - `description` string: Detailed description of the business - `facebookUrl` string: URL of the business's Facebook page - `googleAdsPhone` string: Google Ads-specific phone number - `hideAddress` boolean: Set to true if location is a Service Area Business - `instagramUrl` string: URL of the business's Instagram page - `linkedinUrl` string: URL of the business's LinkedIn page - `offeringsUrl` unknown - `ownerEmail` string: Email of the business owner - `ownerName` string: Name of the business owner - `paymentMethods` string[]: Accepted payment methods ("VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" ) - `phone` string: - Must follow the international **E.164 format**. [Ref here.](https://www.twilio.com/docs/glossary/what-e164) - Do not include the `+` sign or country code. - Remove parentheses and special characters. - Example: - **Incorrect**: `(123)-456-7890`, `+1-123-456-7890` - **Correct**: `1234567890` - `additionalPhones` string[]: Additional contact phone numbers - `pinterestUrl` string: URL of the business's Pinterest page - `postalCode` string: Postal code of the business location - `reservationUrl` unknown - `serviceItems` string[] - `stateIso` string: State ISO code. Refer to the Places API for valid ISOs. - `storeId` unknown - `street` string: Street address of the business - `street1` string: Additional street address information - `subCategoryId` integer: ID of the subcategory the business belongs to - `additionalCategoryIds` string[]: Additional category IDs for the business - `tagline` string: Tagline of the business - `tags` string[] - `temporarilyClosed` boolean: Set to true if the location's business hours should be marked as closed - `tiktokUrl` unknown - `twitterUrl` string: URL of the business's Twitter page - `videos` string[]: List of valid video URLs - `yearOfIncorporation` integer: Year the business was established - `youtubeUrl` unknown - `enabledSiteIds` integer[]: List of site IDs where the business details should be published - `submissionDisabledSiteIds` integer[]: List of site IDs where the business details should not be published - `placeActionLinks` object[], required - `placeActionType` 'APPOINTMENT' | 'ONLINE_APPOINTMENT' | 'DINING_RESERVATION' | 'FOOD_ORDERING' | 'FOOD_DELIVERY' | 'FOOD_TAKEOUT', required: One of the valid types. - `isPreferred` boolean, required: Marks this link preferred for its type. At most one preferred per type. - `uri` string, required: Destination URL. - `name` string: The link's identifier, returned by the read endpoints once the link has synced to Google. Optional on write — include it (when available) to target a specific saved link most accurately. - `action` string: add (default) or delete (for deleting saved uri) ## Response `200` Location created successfully - object - `data` object, required: Contains the response data for the create location request. - `updateLocation` object, required: Encapsulates details about the created location. - `clientMutationId` unknown, required - `errors` object[], nullable, required: Errors encountered during the location creation process, if any. Null if no errors. - `code` string - `contextInfo` object[] - `key` string - `value` string - `message` string - `location` object, required: Details of the created location. - `accountId` integer, required: Unique identifier of the account associated with the location. - `additionalCategoryIds` string[], required: List of additional category IDs assigned to the location. - `additionalInfo` unknown, required - `additionalPhones` string[], required: List of additional phone numbers associated with the location. - `archived` boolean, required: Indicates whether the location has been archived. - `archivedAt` unknown, required - `billingPeriod` unknown, required - `bizUrl` string, required: URL of the business website. - `bookingUrl` unknown, required - `businessHours` object[], required: List of business hours for each day of the week. - `day` string, required: Day of the week. - `slots` object[], required: Time slots indicating when the business is open. - `end` string, required: Closing time of the slot. - `start` string, required: Opening time of the slot. - `specialDate` string, nullable, required: Special date for business hours, if applicable. - `type` string, required: Type of business hour entry (e.g., OPEN, CLOSED). - `categoryId` integer, required: ID of the primary category assigned to the business. - `city` string, required: City where the business is located. - `countryIso` string, required: Country ISO code of the business location. - `customAttributes` object[], required - `archived` boolean, required - `enumValues` string[], required - `name` string, required - `slug` string, required - `type` string, required - `value` string[], required - `databaseId` integer, required: Internal id - `description` string, required: Detailed description of the business. - `facebookUrl` string, required: URL of the business's Facebook page. - `folderId` string, required - `folderName` string, required - `googleAdsPhone` string, required - `googleplusUrl` unknown, required - `hideAddress` boolean, required: If the location is an SAB - `id` string, required: Encoded Location Id in base64 format. Location: - `instagramUrl` string, required: URL of the business's Instagram profile. - `isRestaurant` boolean, required - `latitude` number, required - `linkedinUrl` string, required: URL of the business's LinkedIn profile. - `locationPhotos` string[], required - `longitude` number, required - `moreHours` string[], required: The time periods during which a location is open for certain types of business. Only for Google - `name` string, required: Name of the business. - `offeringsUrl` unknown, required - `ownerEmail` string, required: Email of the business owner. - `ownerName` string, required - `package` string, required - `paymentMethods` string[], required: Accepted payment methods ("VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" ) - `phone` string, required: Primary contact phone number. - `pinterestUrl` string, required - `planId` integer, required - `planName` string, required - `postalCode` string, required - `publisherAttributes` string[], required - `reservationUrl` unknown, required - `serviceItems` string[], required - `stateIso` string, required: State ISO code of the business location. - `storeId` unknown, required - `street` string, required: Street address of the business. - `street1` string, required - `subCategory` object, required - `databaseId` integer, required - `id` string, required - `name` string, required - `primary` boolean, required - `subCategoryId` integer, required - `subCategoryName` string, required - `tagline` string, required - `tags` string[], required - `temporarilyClosed` boolean, required: Indicates whether the business is temporarily closed. - `tiktokUrl` unknown, required - `toplineMessage` unknown, required - `toplineMessageText` unknown, required - `twitterUrl` string, required: URL of the business's Twitter profile. - `videos` string[], required - `yearOfIncorporation` integer, required: Year in which the business was established. - `youtubeUrl` unknown, required - `success` boolean, required: Indicates whether the location creation was successful. - `warnings` string[], required: List of warnings generated during the request processing, if any. - `code` string, required ## Other responses - `400` --- [API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)