Posts Overview

Overview

This API provides social post management for locations, enabling businesses to create, view, and delete posts across platforms like Google. Posts can be of type ANNOUNCEMENT, EVENT, or OFFER, and can be created individually or in bulk across multiple locations.

Posts are published to the configured sites (e.g., Google) and can include contextual information such as event dates, offer details, and call-to-action links.

Post API Attributes

Given below are the response fields returned for the API endpoints in Posts.

Create a post (ANNOUNCEMENT, EVENT, or OFFER)

Name	Field Type	Description
`id`	String	The unique ID of the created post
`postName`	String	The internal name given to the post
`postType`	String	The type of post: `ANNOUNCEMENT`, `EVENT`, or `OFFER`
`postSites`	Array	The list of sites the post is published to, e.g. `["GOOGLE"]`
`postStatus`	String	The current status of the post, e.g. `PUBLISHED` or `PENDING`
`postMessage`	Array of Objects	An array of per-site message objects
`postContextInfo`	Object	Additional context for EVENT or OFFER posts (dates, coupon, etc.)
`postCta`	Array of Objects	Call-to-action links per site, applicable to OFFER posts

`postMessage` object fields

Name	Field Type	Description
`site`	String	The site this message is targeted at, e.g. `GOOGLE`
`message`	String	The body text of the post for that site

`postContextInfo` object fields

Name	Field Type	Description
`title`	String	The title of the event or offer
`startDay`	String	Start date in `YYYY-MM-DD` format
`startTime`	String	Start time in `HH:MM` format
`endDay`	String	End date in `YYYY-MM-DD` format
`endTime`	String	End time in `HH:MM` format
`couponCode`	String	Coupon code for the offer (OFFER type only)
`redeemUrl`	String	URL where the offer can be redeemed (OFFER type only)
`termsConditions`	String	Terms and conditions text for the offer (OFFER type only)

`postCta` object fields

Name	Field Type	Description
`site`	String	The site this CTA applies to, e.g. `GOOGLE`
`type`	String	The CTA button type, e.g. `LEARN_MORE`, `BUY`, `ORDER`, `SIGN_UP`, `CALL`
`url`	String	The URL the CTA button links to

Fetch posts for a location

Name	Field Type	Description
`id`	String	The unique ID of the post
`postName`	String	The internal name of the post
`postType`	String	The type of post: `ANNOUNCEMENT`, `EVENT`, or `OFFER`
`postStatus`	String	The current status of the post
`postSites`	Array	Sites the post is published to
`publishedAt`	Datetime	The date and time the post was published
`postMessage`	Array of Objects	Per-site message content

Query parameters:

Name	Field Type	Description
`page`	Integer	Page number for paginated results
`perPage`	Integer	Number of posts to return per page
`tag`	String	Optional tag filter

Get a single post

Name	Field Type	Description
`id`	String	The unique ID of the post
`postName`	String	The internal name of the post
`postType`	String	The type of post: `ANNOUNCEMENT`, `EVENT`, or `OFFER`
`postStatus`	String	The current status of the post
`postSites`	Array	Sites the post is published to
`publishedAt`	Datetime	The date and time the post was published
`postMessage`	Array of Objects	Per-site message content
`postContextInfo`	Object	Event or offer context
`postCta`	Array of Objects	Call-to-action links

Delete a post

Name	Field Type	Description
`id`	String	The unique ID of the deleted post
`archived`	Boolean	`true` if the post was successfully deleted

Create a bulk post

Bulk posts use the same request structure as individual posts. The key difference is that locationIds can contain multiple location IDs, and the post is created across all of them in a single request.

Name	Field Type	Description
`id`	String	The unique ID of the bulk post job
`postName`	String	The internal name of the bulk post
`postType`	String	The type of post: `ANNOUNCEMENT`, `EVENT`, or `OFFER`
`postSites`	Array	Sites the post is published to
`locationIds`	Array	The list of location IDs the post is distributed to
`postStatus`	String	The overall status of the bulk post job

Fetch a bulk post by ID

Name	Field Type	Description
`id`	String	The unique ID of the bulk post
`postName`	String	The internal name of the bulk post
`postType`	String	The type of post
`postStatus`	String	The current status of the bulk post
`postSites`	Array	Sites the post is published to
`locationIds`	Array	The list of location IDs associated with this bulk post
`postMessage`	Array of Objects	Per-site message content
`postContextInfo`	Object	Event or offer context if applicable

Fetch bulk posts for a location

Name	Field Type	Description
`id`	String	The unique ID of the bulk post
`postName`	String	The internal name of the bulk post
`postType`	String	The type of post
`postStatus`	String	The current status of the bulk post
`postSites`	Array	Sites the post is published to
`publishedAt`	Datetime	The date and time the bulk post was published
`postMessage`	Array of Objects	Per-site message content

Query parameters: page, perPage, tag — same as Fetch posts for a location.