Skip to content
API Reference/
/
Create a Social Post

Create a Social Post

Request

Create a new Social Post. Requires either one businessId or one locationId or one label. When a combination of those fields is provided all matching locations are added together.

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A SocialPost object

titlestring

The title of the Social Post.

descriptionstring

The title of the Social Post.

urlstring

A link for the Social Post. This is mandatory for a "Special Offer" and should point to a page concerning the offer

typestringrequired

The type of the Social Post. POST, OFFER, ALERT, EVENT, REEL, STORY or CAROUSEL.

Enum:"POST""OFFER""ALERT""EVENT""QUESTION_AND_ANSWER""REEL""STORY""CAROUSEL"
alertTypestring

A special type for Google ALERT posts. Possible values are COVID_19.

Value:"COVID_19"
idinteger, (int64)

Id

campaignIdinteger, (int64)

The campaign ID this Social Post belongs to

campaignobject

Social Post Campaign Model

statusstring

The current status of the Social Post (scheduled, active, inactive, not_published, published, impossible)

Enum:"SCHEDULED""APPROVAL_NEEDED""ACTIVE""INACTIVE""DELETED""IMPOSSIBLE""INCOMPLETE""ENDED""REJECTED"
dateStartstring, (date-time)

The starting date of EVENT and OFFER type Social Posts. It is used to indicate when an EVENT/OFFER will start. For API versions older than 2021-08-04, it is used as publicationDate.

dateEndstring, (date-time)

The ending date of the Social Post (type=OFFER). The post will be removed from the listings at that date. It also determines when a special offer should end.

publicationDatestring, (date-time)required

The date on which the Social Post will be published. It is used to schedule posts in the future. Format: yyyy-MM-dd'T'HH:mm:ss'Z'

Example:"2024-06-25T11:01:00Z"
isStoreLocatorboolean

When enabled, the SocialPost will be visible in StoreLocator

productNamestring

Product name for product posts

timeZonestring

The timezone in which the Social Post should be created

Example:"Europe/Berlin"
productPriceMininteger, (int32)

Minimum product price

productPriceMaxinteger, (int32)

Maximum product price

productCurrencystring

Currency of the product price

Enum:"EUR""USD""GBP""CHF""AUD""RUB""JPY""AED""AFN""ALL"
labelsArray of strings, unique

The list of location labels as entered when creating/updating the Social Post

photosArray of objects

The Social Post photos

callToActionsArray of objects

Social Post Call to Action

firstCommentstring

The first comment to be posted after a post creation. Only available for INSTAGRAM

mentionsArray of objects

The mentions of the social post

statusPerDirectoryobject
publicationsCountinteger, (int64)

Publications count

directoriesArray of stringsrequired

The list of directories as entered when creating/updating the Social Post.

curl -i -X POST \
  https://uberall.com/api/social-posts \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "url": "string",
    "type": "POST",
    "alertType": "COVID_19",
    "id": 0,
    "campaignId": 0,
    "campaign": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "status": "SCHEDULED",
    "dateStart": "2019-08-24T14:15:22Z",
    "dateEnd": "2019-08-24T14:15:22Z",
    "publicationDate": "2024-06-25T11:01:00Z",
    "isStoreLocator": true,
    "productName": "string",
    "timeZone": "Europe/Berlin",
    "productPriceMin": 0,
    "productPriceMax": 0,
    "productCurrency": "EUR",
    "labels": [
      "string"
    ],
    "photos": [
      {
        "redirectUrl": "string",
        "photo": "string",
        "description": "string"
      }
    ],
    "callToActions": [
      {
        "url": "string",
        "directory": "string",
        "type": "string"
      }
    ],
    "firstComment": "string",
    "mentions": [
      {
        "id": "string",
        "name": "string",
        "link": "string",
        "avatar": "string"
      }
    ],
    "statusPerDirectory": {},
    "publicationsCount": 0,
    "directories": [
      "string"
    ]
  }'

Responses

Social Posts created.

Bodyapplication/json
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired
Response
CreateSocialPostExample
{
  "status": "SUCCESS",
  "response": {
    "type": "POST",
    "status": "SCHEDULED",
    "dateStart": null,
    "url": null,
    "title": "Example Holiday Promotion Post",
    "firstComment": "Don't forget to visit our website for more details!",
    "videos": [],
    "description": "Happy Holidays from our team! Check out our special seasonal offers.",
    "timeZone": "Europe/Berlin",
    "locationIds": [ … ],
    "businessIds": [],
    "excludedLocationIds": [],
    "businessPages": [],
    "listingPages": [],
    "locationGroups": [],
    "mentions": [],
    "isStoreLocator": true,
    "publicationDate": "2025-12-25T11:01:00Z",
    "canEdit": true,
    "photos": [],
    "locationName": "Main Street Branch",
    "callToActions": [],
    "directories": [ … ],
    "owner": { … },
    "statusPerDirectory": {},
    "publicationsCount": null
  }
}