Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/posts

Create a post

Creates a Google Business Profile post for one or more locations.

The post shape is selected by input.postType. See the Announcement, Event and Offer references for the fields each type accepts.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Body

NameTypeRequiredDescription
inputone ofrequired

input: ANNOUNCEMENT

NameTypeRequiredDescription
input.postNamestringrequired
input.locationIdsarray of stringrequired
input.postTypestringrequired
input.postSitesarray of stringrequired
input.postMessagearray of objectrequired
input.postMessage[].sitestringoptional
input.postMessage[].messagestringoptional

input: EVENT

NameTypeRequiredDescription
input.postNamestringrequired
input.locationIdsarray of stringrequired
input.postTypestringrequired
input.postSitesarray of stringrequired
input.postMessagearray of objectrequired
input.postMessage[].sitestringoptional
input.postMessage[].messagestringoptional
input.postContextInfoobjectrequired
input.postContextInfo.titlestringrequired
input.postContextInfo.startDaystringrequired
input.postContextInfo.startTimestringrequired
input.postContextInfo.endDaystringrequired
input.postContextInfo.endTimestringrequired

input: OFFER

NameTypeRequiredDescription
input.postNamestringrequired
input.locationIdsarray of stringrequired
input.postTypestringrequired
input.postSitesarray of stringrequired
input.postMessagearray of objectrequired
input.postMessage[].sitestringoptional
input.postMessage[].messagestringoptional
input.postContextInfoobjectrequired
input.postContextInfo.titlestringrequired
input.postContextInfo.couponCodestringrequired
input.postContextInfo.redeemUrlstringrequired
input.postContextInfo.termsConditionsstringrequired
input.postContextInfo.startDaystringrequired
input.postContextInfo.startTimestringrequired
input.postContextInfo.endDaystringrequired
input.postContextInfo.endTimestringrequired
input.postCtaarray of objectrequired
input.postCta[].sitestringoptional
input.postCta[].typestringoptional
input.postCta[].urlstringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/posts' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "postName": "Grand Opening Announcement",
    "locationIds": [
      "{locationId}"
    ],
    "postType": "ANNOUNCEMENT",
    "postSites": [
      "GOOGLE"
    ],
    "postMessage": [
      {
        "site": "GOOGLE",
        "message": "We are now open!"
      }
    ]
  }
}'

Responses

StatusDescription
200
Example response (generated from the schema)
{}