PATCH
/
user
/
:platform
Available on Premium, Business, Enterprise plans.

Update the account or user data of the social network. Currently only Google Business Profile is supported.

Google limits updating some Google Business Profile location fields to being updated 5 times within a rolling 24-hour period. For example updating phoneNumbers more than 5 times in a rolling 24-hour period will return a 400 Response.

Header Parameters

Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
Profile-Key
string
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Path Parameters

:platform
string
required

Values: gbp

Body Parameters

phoneNumbers
object

Object containing the different phone numbers that customers can use to get in touch with the business.

"phoneNumbers": {
    "primaryPhone": "212-123-4567",
    "additionalPhones": [
        "212-432-2342"
    ]
}
name
string

Google identifier for this location in the form.

adPhone
string

An alternate phone number to display on AdWords location extensions instead of the location’s primary phone number.

storeCode
string

External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.

title
string

Location name should reflect your business’s real-world name, as used consistently on your storefront, website, and stationery, and as known to customers.

websiteUrl
string

A URL for this business.

labels
array

A collection of free-form strings to allow you to tag your business. These labels are not user facing; only you can see them. Must be between 1-255 characters per label.

latlng
object

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard.

{
    "latitude": number,
    "longitude": number
}

Values must be within normalized ranges.

The latitude in degrees. It must be in the range [-90.0, +90.0].

The longitude in degrees. It must be in the range [-180.0, +180.0].

profile
object

This field contains a description of the location in your own voice. The description is not editable by anyone else.

{
    "description": string
}