Skip to main content
POST
/
gbp
/
posts
Create a GBP post
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/gbp/posts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "location_id": "<string>",
  "content_text": "<string>",
  "post_type": "NEWS"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "posted",
    "google_post_id": "<string>",
    "publish_at_utc": "2023-11-07T05:31:56Z",
    "scheduled_timezone": "<string>",
    "location_id": "<string>",
    "post_type": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
location_id
string
required

GBP location ID from connected locations

content_text
string
required

Post body text

post_type
enum<string>
required
Available options:
NEWS,
EVENT,
OFFER,
CALL_TO_ACTION
media_url
string<uri>

URL of an image to attach

publish_at_utc
string<date-time>

Schedule the post for this UTC time. Omit for immediate publishing.

scheduled_timezone
string

Required when publish_at_utc is set. IANA timezone (e.g. America/Chicago).

event_title
string

Event title (required for EVENT and OFFER post types)

start_date
string

Event start date (YYYY-MM-DD)

start_time
string

Event start time (HH:MM)

end_date
string

Event end date (YYYY-MM-DD)

end_time
string

Event end time (HH:MM)

action_type
enum<string>

Call-to-action button type (for CALL_TO_ACTION posts)

Available options:
ORDER,
BOOK,
SHOP,
LEARN_MORE,
SIGN_UP,
CALL
action_url
string<uri>

CTA button URL

coupon_code
string

Coupon code (for OFFER posts)

redeem_url
string<uri>

Offer redemption URL

terms_conditions
string

Offer terms and conditions

Response

Post created (immediate) or scheduled

data
object
Last modified on April 13, 2026