Skip to main content
gbp:write The gbp:write scope allows you to create, schedule, cancel, reschedule, and delete Google Business Profile posts.

​
Endpoints

MethodPathDescription
POST/public/gbp/postsCreate or schedule a post
POST/public/gbp/posts/{id}/cancelCancel a scheduled post
POST/public/gbp/posts/{id}/rescheduleReschedule a post
DELETE/public/gbp/posts/{id}Delete a post

​
Create a GBP post

POST /public/gbp/posts
Publishes a post immediately or schedules it for a future time.

​
Request body

FieldTypeRequiredDescription
location_idstringYesGBP location ID
content_textstringYesPost body text
post_typestringYesNEWS, EVENT, OFFER, or CALL_TO_ACTION
media_urlstringNoImage URL
publish_at_utcstringNoISO 8601 UTC time to schedule (omit for immediate)
scheduled_timezonestringNoRequired with publish_at_utc (e.g. America/Chicago)
event_titlestringNoRequired for EVENT/OFFER types
start_datestringNoYYYY-MM-DD
start_timestringNoHH:MM
end_datestringNoYYYY-MM-DD
end_timestringNoHH:MM
action_typestringNoCTA type: ORDER, BOOK, SHOP, LEARN_MORE, SIGN_UP, CALL
action_urlstringNoCTA destination URL
coupon_codestringNoOffer coupon code
redeem_urlstringNoOffer redemption URL
terms_conditionsstringNoOffer terms

​
Example

curl -X POST https://api.app.hrizn.io/v1/public/gbp/posts \
  -H "X-API-Key: hzk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "location_id": "locations/456",
    "content_text": "Spring service special — 20% off all maintenance!",
    "post_type": "NEWS"
  }'

​
Cancel a scheduled post

POST /public/gbp/posts/{id}/cancel
Cancels a scheduled post. Only posts with status scheduled can be cancelled.

​
Example

curl -X POST https://api.app.hrizn.io/v1/public/gbp/posts/a1b2c3d4-.../cancel \
  -H "X-API-Key: hzk_your_key_here"

​
Reschedule a post

POST /public/gbp/posts/{id}/reschedule
Moves a scheduled or failed post to a new time.

​
Request body

FieldTypeRequiredDescription
publish_at_utcstringYesNew UTC time (must be in the future)
scheduled_timezonestringYesIANA timezone

​
Example

curl -X POST https://api.app.hrizn.io/v1/public/gbp/posts/a1b2c3d4-.../reschedule \
  -H "X-API-Key: hzk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "publish_at_utc": "2026-04-20T15:00:00.000Z",
    "scheduled_timezone": "America/New_York"
  }'

​
Delete a post

DELETE /public/gbp/posts/{id}
Permanently deletes a post. Posted posts are unpublished from Google first.

​
Example

curl -X DELETE https://api.app.hrizn.io/v1/public/gbp/posts/a1b2c3d4-... \
  -H "X-API-Key: hzk_your_key_here"

​
Status codes

StatusDescription
200Success (cancel, reschedule, delete)
201Post created/scheduled
400Validation error or invalid state transition
401Missing or invalid API key
403API key lacks gbp:write scope
404Post not found
429Rate limit exceeded
500Internal error
Last modified on March 27, 2026