ACME API Documentation logo

Update User

Update the account or user data of the social network

PATCHhttps://api.acme.com/api/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

Authorizationstringrequired
API Key of the Primary Profile.

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

Format: Profile-Key: PROFILE_KEY

Path Parameters

:platformstringrequired

Values: gbp

Body Parameters

phoneNumbersobject

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"
    ]
}
namestring

Google identifier for this location in the form.

adPhonestring

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

storeCodestring

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.

titlestring

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

websiteUrlstring

A URL for this business.

labelsarray

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.

latlngobject

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].

profileobject

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

{
    "description": string
}
{
    "gmb": {
        "status": "success",
        "data": {
            "name": "locations/4913369732395328466",
            "languageCode": "en",
            "title": "ACME",
            "phoneNumbers": {},
            "categories": {
                "primaryCategory": {
                    "name": "categories/gcid:software_company",
                    "displayName": "Software company",
                    "serviceTypes": [
                        {
                            "serviceTypeId": "job_type_id:application_development",
                            "displayName": "Application development"
                        },
                        {
                            "serviceTypeId": "job_type_id:big_data_consulting_and_implementation",
                            "displayName": "Big data consulting & implementation"
                        },
                        {
                            "serviceTypeId": "job_type_id:data_center_management",
                            "displayName": "Data center management"
                        },
                        {
                            "serviceTypeId": "job_type_id:data_quality_management",
                            "displayName": "Data quality management"
                        },
                        {
                            "serviceTypeId": "job_type_id:enterprise_software_development",
                            "displayName": "Enterprise software development"
                        },
                        {
                            "serviceTypeId": "job_type_id:it_consulting",
                            "displayName": "It consulting"
                        },
                        {
                            "serviceTypeId": "job_type_id:mobile_app_development",
                            "displayName": "Mobile app development"
                        },
                        {
                            "serviceTypeId": "job_type_id:platform_consulting",
                            "displayName": "Platform consulting"
                        },
                        {
                            "serviceTypeId": "job_type_id:security_services_management",
                            "displayName": "Security services management"
                        },
                        {
                            "serviceTypeId": "job_type_id:software_consulting",
                            "displayName": "Software consulting"
                        },
                        {
                            "serviceTypeId": "job_type_id:software_development",
                            "displayName": "Software development"
                        },
                        {
                            "serviceTypeId": "job_type_id:software_development_outsourcing",
                            "displayName": "Software development outsourcing"
                        },
                        {
                            "serviceTypeId": "job_type_id:solution_consulting",
                            "displayName": "Solution consulting"
                        }
                    ],
                    "moreHoursTypes": [
                        {
                            "hoursTypeId": "ACCESS",
                            "displayName": "Access",
                            "localizedDisplayName": "Access"
                        },
                        {
                            "hoursTypeId": "BREAKFAST",
                            "displayName": "Breakfast",
                            "localizedDisplayName": "Breakfast"
                        },
                        {
                            "hoursTypeId": "BRUNCH",
                            "displayName": "Brunch",
                            "localizedDisplayName": "Brunch"
                        },
                        {
                            "hoursTypeId": "DELIVERY",
                            "displayName": "Delivery",
                            "localizedDisplayName": "Delivery"
                        },
                        {
                            "hoursTypeId": "DINNER",
                            "displayName": "Dinner",
                            "localizedDisplayName": "Dinner"
                        },
                        {
                            "hoursTypeId": "DRIVE_THROUGH",
                            "displayName": "Drive through",
                            "localizedDisplayName": "Drive through"
                        },
                        {
                            "hoursTypeId": "HAPPY_HOUR",
                            "displayName": "Happy hours",
                            "localizedDisplayName": "Happy hours"
                        },
                        {
                            "hoursTypeId": "KITCHEN",
                            "displayName": "Kitchen",
                            "localizedDisplayName": "Kitchen"
                        },
                        {
                            "hoursTypeId": "LUNCH",
                            "displayName": "Lunch",
                            "localizedDisplayName": "Lunch"
                        },
                        {
                            "hoursTypeId": "ONLINE_SERVICE_HOURS",
                            "displayName": "Online service hours",
                            "localizedDisplayName": "Online service hours"
                        },
                        {
                            "hoursTypeId": "PICKUP",
                            "displayName": "Pickup",
                            "localizedDisplayName": "Pickup"
                        },
                        {
                            "hoursTypeId": "TAKEOUT",
                            "displayName": "Takeout",
                            "localizedDisplayName": "Takeout"
                        },
                        {
                            "hoursTypeId": "SENIOR_HOURS",
                            "displayName": "Senior hours",
                            "localizedDisplayName": "Senior hours"
                        }
                    ]
                },
                "additionalCategories": [
                    {
                        "name": "categories/gcid:automation_company",
                        "displayName": "Automation company",
                        "moreHoursTypes": [
                            {
                                "hoursTypeId": "ACCESS",
                                "displayName": "Access",
                                "localizedDisplayName": "Access"
                            },
                            {
                                "hoursTypeId": "BREAKFAST",
                                "displayName": "Breakfast",
                                "localizedDisplayName": "Breakfast"
                            },
                            {
                                "hoursTypeId": "BRUNCH",
                                "displayName": "Brunch",
                                "localizedDisplayName": "Brunch"
                            },
                            {
                                "hoursTypeId": "DELIVERY",
                                "displayName": "Delivery",
                                "localizedDisplayName": "Delivery"
                            },
                            {
                                "hoursTypeId": "DINNER",
                                "displayName": "Dinner",
                                "localizedDisplayName": "Dinner"
                            },
                            {
                                "hoursTypeId": "DRIVE_THROUGH",
                                "displayName": "Drive through",
                                "localizedDisplayName": "Drive through"
                            },
                            {
                                "hoursTypeId": "HAPPY_HOUR",
                                "displayName": "Happy hours",
                                "localizedDisplayName": "Happy hours"
                            },
                            {
                                "hoursTypeId": "KITCHEN",
                                "displayName": "Kitchen",
                                "localizedDisplayName": "Kitchen"
                            },
                            {
                                "hoursTypeId": "LUNCH",
                                "displayName": "Lunch",
                                "localizedDisplayName": "Lunch"
                            },
                            {
                                "hoursTypeId": "ONLINE_SERVICE_HOURS",
                                "displayName": "Online service hours",
                                "localizedDisplayName": "Online service hours"
                            },
                            {
                                "hoursTypeId": "PICKUP",
                                "displayName": "Pickup",
                                "localizedDisplayName": "Pickup"
                            },
                            {
                                "hoursTypeId": "TAKEOUT",
                                "displayName": "Takeout",
                                "localizedDisplayName": "Takeout"
                            },
                            {
                                "hoursTypeId": "SENIOR_HOURS",
                                "displayName": "Senior hours",
                                "localizedDisplayName": "Senior hours"
                            }
                        ]
                    }
                ]
            },
            "storefrontAddress": {
                "regionCode": "US",
                "languageCode": "en",
                "postalCode": "10019",
                "administrativeArea": "NY",
                "locality": "New York",
                "addressLines": [
                    "142 W 57th St"
                ]
            },
            "websiteUri": "https://www.acme.com/",
            "regularHours": {
                "periods": [
                    {
                        "openDay": "SUNDAY",
                        "openTime": {},
                        "closeDay": "SUNDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    },
                    {
                        "openDay": "MONDAY",
                        "openTime": {},
                        "closeDay": "MONDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    },
                    {
                        "openDay": "TUESDAY",
                        "openTime": {},
                        "closeDay": "TUESDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    },
                    {
                        "openDay": "WEDNESDAY",
                        "openTime": {},
                        "closeDay": "WEDNESDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    },
                    {
                        "openDay": "THURSDAY",
                        "openTime": {},
                        "closeDay": "THURSDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    },
                    {
                        "openDay": "FRIDAY",
                        "openTime": {},
                        "closeDay": "FRIDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    },
                    {
                        "openDay": "SATURDAY",
                        "openTime": {},
                        "closeDay": "SATURDAY",
                        "closeTime": {
                            "hours": 24
                        }
                    }
                ]
            },
            "serviceArea": {
                "businessType": "CUSTOMER_AND_BUSINESS_LOCATION",
                "places": {
                    "placeInfos": [
                        {
                            "placeName": "United States",
                            "placeId": "ChIJCzYy5IS16lQRQrfeQ5K5Oxw"
                        }
                    ]
                },
                "regionCode": "US"
            },
            "openInfo": {
                "status": "OPEN",
                "canReopen": true
            },
            "metadata": {
                "hasPendingEdits": true,
                "canDelete": true,
                "canModifyServiceList": true,
                "placeId": "ChIJN53jw8BZwokRBEeVVtPLkkg",
                "mapsUri": "https://maps.google.com/maps?cid=5229466225881728772",
                "newReviewUri": "https://search.google.com/local/writereview?placeid=ChIJN53jw8BZwokRBEeVVtPLkkg",
                "hasVoiceOfMerchant": true
            },
            "profile": {
                "description": "Easy to integrate Social Media APIs allow you to manage all your users' social accounts right from your product. Post, Auto Schedule, and Analytics. Great for SaaS, CMS, DAM, Agencies, and Apps."
            }
        }
    }
}