Skip to content
API Reference
/
Social Posting
/
Get a list of Directory Pages

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers

https://uberall.com/api/

Mock Server

https://docs.uberall.com/_mock/apis/swagger/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Update a Social Post

Request

Edit an existing Social Post identified by its unique uberall ID.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique ID of the Social Post yu want to edit

Bodyapplication/jsonrequired

A SocialPost object

titlestring

The title of the Social Post. For type QUESTION_AND_ANSWER this is going to be the question.

descriptionstring

The description of the Social Post. For type QUESTION_AND_ANSWER this is going to be the answer.

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, QUESTION_AND_ANSWER, EVENT or ALERT.

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

statusstring

The current status of the Social Post (scheduled, active, inactive, deleted, 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 20210804, 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:ssXXXXX (Example: 2007-12-03T10:15:30+01:00)

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

When enabled, the SocialPost will be visible in StoreLocator.

productNamestring

The name of the product for a Product Social Post. A Social Post becomes a Product Social Post if that field is set.

timeZonestring

The timezone in which the Social Post should be created

Example: "Europe/Berlin"
productPriceMininteger(int32)

Lower price of a Product Social Post if the product has a price range, or the price for the product.

productPriceMaxinteger(int32)

Upper price of the product for Product Social Post. If the price is just a single price and not a range, set only productPriceMin.

productCurrencystring

The currency of a Product Social Post. It is a 3-letters symbol (EUR, USD, ...).

Enum"EUR""USD""GBP""CHF""AUD""RUB""JPY""AED""AFN""ALL"
labelsArray of stringsunique

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

Example: "['Campaign2018', 'EastCoast']"
photosArray of objects(SocialPostPhoto)

The social post's photos

callToActionsArray of objects(SocialPostCallToAction)

Social Post Call to Action

firstCommentstring

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

mentionsArray of objects(SocialPostMentions)

The mentions of the social post

statusPerDirectoryobject
publicationsCountinteger(int64)

Publications count

videosArray of strings

The video of the social post (can only be one)

businessIdsArray of integers(int64)

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

locationIdsArray of integers(int64)

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

listingPagesArray of integers(int64)

The list of listing page IDs as entered when creating/updating the Social Post.

businessPagesArray of integers(int64)

The list of business page IDs as entered when creating/updating the Social Post.

locationGroupsArray of integers(int64)
excludedLocationIdsArray of integers(int64)

List of locationIds that should be excluded from the request. Can be used in combination with businessId when some locations should not be considered.

directoriesArray of objects(SocialPostDirectory)required

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

directories[].​typestring

The type of the directory

Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
directories[].​urlstring

The URL of the directory

couponCodestring

A couponCode for redeeming a "Special Offer" (SocialPost.type=OFFER). Currently only supported for Google Posts.

termsAndConditionsstring

Terms and Conditions for redeeming a "Special Offer" (SocialPost.type=OFFER). Currently only supported for Google Posts.

canEditboolean
locationNamestring
businessNamestring
warningsArray of strings
insightsArray of objects(SocialPostInsights)
ownerobject

Social Post Owner Model

curl -i -X PATCH \
  'https://uberall.com/api/social-posts/{id}' \
  -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,
    "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": "['\''Campaign2018'\'', '\''EastCoast'\'']",
    "photos": [
      {
        "redirectUrl": "string",
        "photo": "string",
        "description": "string"
      }
    ],
    "callToActions": [
      {
        "url": "string",
        "type": "string",
        "directory": "string"
      }
    ],
    "firstComment": "string",
    "mentions": [
      {
        "id": "string",
        "name": "string",
        "link": "string",
        "avatar": "string"
      }
    ],
    "statusPerDirectory": {},
    "publicationsCount": 0,
    "videos": [
      "string"
    ],
    "businessIds": [
      0
    ],
    "locationIds": [
      0
    ],
    "listingPages": [
      0
    ],
    "businessPages": [
      0
    ],
    "locationGroups": [
      0
    ],
    "excludedLocationIds": [
      0
    ],
    "directories": [
      {
        "type": "FOURSQUARE",
        "url": "string"
      }
    ],
    "couponCode": "string",
    "termsAndConditions": "string",
    "canEdit": true,
    "locationName": "string",
    "businessName": "string",
    "warnings": [
      "string"
    ],
    "insights": [
      {
        "metrics": {
          "property1": 0,
          "property2": 0
        }
      }
    ],
    "owner": {
      "id": 0,
      "name": "string",
      "isApiAdmin": true
    }
  }'

Responses

Social Post updated

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​socialPostobject

A Social Post is a message for your customers that will be published on some of your listings. This can be a "News", a "Special Offer" or a "Question and Answer".

Response
application/json

PatchSocialPostIdExample

{
  "status": "SUCCESS",
  "message": "SocialPost has been successfully updated.",
  "warnings": [
    "'dateStart' was ignored as updating it is no longer possible."
  ],
  "response": {
    "socialPost": { … }
  }
}

Get a list of Directory Pages

Request

Get several Directory Pages.

Security
X-API-KEY or Authorization
Query
typesstring

The directory types we want pages for.

levelsstring

String that represents the level of a directory page. The 2 possible values are "LISTING" and "BUSINESS"

locationIdsArray of strings

Return directory pages where input locationIds have access to

pageinteger(int64)

Used for pagination. Page number we're interested in

sizeinteger(int64)

Used for pagination. It indicates the amount of result to be returned in a single page

querystring

Filter by page name

curl -i -X GET \
  'https://uberall.com/api/social-posts/directory-pages?types=string&levels=string&locationIds=string&page=0&size=0&query=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Directory Pages retrieved

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

List Directory Pages Response Model

response.​pageinteger(int32)

The page number

response.​sizeinteger(int32)

The number of elements in the page

response.​totalSizeinteger(int64)

The total number of elements

response.​directoryPagesArray of objects(DirectoryPageResponse)

The list of directory pages

Response
application/json

GetSocialPostDirectoryPageExample

{
  "status": "SUCCESS",
  "response": {
    "directoryPages": [ … ],
    "page": 0,
    "size": 50,
    "totalSize": 1
  }
}

Validate the Apple CTA

Request

Check if the CTA is valid for an Apple post

Security
X-API-KEY or Authorization
Query
ctastringrequired

The call to action

locationIdsArray of stringsrequired

The location IDs

curl -i -X POST \
  'https://uberall.com/api/social-posts/validate-apple-cta?cta=string&locationIds=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

All locations support the CTA

Response
No content

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations