PATCH /v1/brands/{brand_id}/gbp/locations/{location_id}/profile

Update a location's profile

scope write:gbp cost 1 RU idempotent optional

Write profile fields to Google: the description (750 characters at most; refused for the kinds of business Google locks it on, see description_locked), the website, the phone, the hours, the primary and additional categories and the services. Only the fields given change, and the change is public on Google at once. Answers the profile as Google keeps it. Requires the brand owner on Starter or with an active API subscription: 403 brand_plan_required otherwise. A brand without Google connected answers 400 google_not_connected, an expired connection 400 google_connection_expired.

Path parameters

location_id string required

The linked location's id, from GET .../gbp/locations.
brand_id string required

Brand UUID.

Query parameters

dry_run boolean optional

Preview the call without executing it. Runs auth, scope, eligibility and body validation, then returns 200 with a dry_run object reporting the request-unit and credit cost plus a non-consuming quota snapshot. Nothing is debited, reserved, dispatched or mutated. An invalid body still returns 422.

default: false

Header parameters

Idempotency-Key string optional

Optional. A retry with the same key and body within 24 hours replays the first response.

Request body

application/json required

Type: GbpProfileUpdate

additional_category_ids array of string (nullable) nullable
primary_category_id string (nullable) nullable
primary_phone string (nullable) nullable
profile_description string (nullable) nullable
regular_hours array of GbpHoursPeriod (nullable) nullable

Every open window of the week, replacing the hours.
service_items array of string (nullable) nullable

Free-form service labels to replace the entire serviceItems list
website_uri string (nullable) nullable

Example payload

{
  "profile_description": "Family dental clinic in Austin with same-day appointments.",
  "service_items": [
    "Teeth cleaning",
    "Whitening"
  ],
  "website_uri": "https://www.rankprompt.com"
}

Responses

Updated a location's profile application/json

Type: GbpProfile

audit GbpAudit required

The profile's completeness score and each field's state.
Show fields

Type: GbpAudit
- grade enum required
- score integer required
  
  min: 0 · max: 100
- field_statuses array of GbpFieldStatus
gbp_location_id string required

Google's location id.
location_id string required

The linked location's id.
additional_categories array of string
additional_category_ids array of string
address_lines array of string
country string (nullable) nullable
description string (nullable) nullable
description_locked boolean

Google refuses edits of the description for this kind of business.

default: `false`
description_locked_reason string (nullable) nullable
formatted_address string (nullable) nullable
locality string (nullable) nullable
maps_uri string (nullable) nullable
new_review_uri string (nullable) nullable

The link that opens a new review of the location.
object string

Always gbp_profile.

default: `gbp_profile`
open_for_business boolean (nullable) nullable
postal_code string (nullable) nullable
primary_category string (nullable) nullable
primary_category_id string (nullable) nullable
primary_phone string (nullable) nullable
region string (nullable) nullable
regular_hours_periods array of GbpHoursPeriod
regular_hours_summary string (nullable) nullable
service_items array of object

The services listed, as Google has them.

Show fields

Array of:

Empty object (no properties).
special_hours_summary string (nullable) nullable
title string (nullable) nullable
website_uri string (nullable) nullable

Request validation failed application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Missing or invalid credentials application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid credentials"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

You do not have permission to access this resource application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "forbidden",
    "message": "You do not have permission to access this resource"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Resource not found application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Resource conflict application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "conflict",
    "message": "Resource conflict"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Request body did not match the expected schema application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "body_validation_error",
    "message": "Request body did not match the expected schema"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Per-minute rate limit exceeded application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Per-minute rate limit exceeded"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

An unexpected error occurred application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Service temporarily unavailable, please retry application/json

Type: ApiError

error object required
Show fields
- code string required
  
  Stable machine-readable error code from the catalog.
- message string required
  
  Human-readable description suitable for logging.
- details object
  
  Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.
  
  Show fields
  
  Empty object (no properties).
request_id string

Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

format: `uuid`

Example response

{
  "error": {
    "code": "service_unavailable",
    "message": "Service temporarily unavailable, please retry"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}

Request example

curl --request PATCH \
  --url 'https://api.rankprompt.com/v1/brands/your_brand_id_here/gbp/locations/your_location_id_here/profile?dry_run=false' \
  --header 'Authorization: Bearer rp_live_<YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profile_description": "Family dental clinic in Austin with same-day appointments.",
  "service_items": [
    "Teeth cleaning",
    "Whitening"
  ],
  "website_uri": "https://www.rankprompt.com"
}'

const fetch = require('node-fetch');

const url = 'https://api.rankprompt.com/v1/brands/your_brand_id_here/gbp/locations/your_location_id_here/profile?dry_run=false';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer rp_live_<YOUR_API_KEY>',
    'Content-Type': 'application/json'
  },
  body: '{"profile_description":"Family dental clinic in Austin with same-day appointments.","service_items":["Teeth cleaning","Whitening"],"website_uri":"https://www.rankprompt.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://api.rankprompt.com/v1/brands/your_brand_id_here/gbp/locations/your_location_id_here/profile"

querystring = {"dry_run":"false"}

payload = {
    "profile_description": "Family dental clinic in Austin with same-day appointments.",
    "service_items": ["Teeth cleaning", "Whitening"],
    "website_uri": "https://www.rankprompt.com"
}
headers = {
    "Authorization": "Bearer rp_live_<YOUR_API_KEY>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers, params=querystring)

print(response.json())