API Reference
/
Social Posting Templates
/
Create a Social Post Template

Uberall API (20250204)

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
Mock server

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

https://uberall.com/api/

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

Social Posting Templates

Products - Social Posting - Social Posting Templates

Operations

Get a Social Post Template

Request

Get several Social Post Templates.

Query
userIdstring

Shows the templates of the user with this id

maxinteger(int64)

Used for pagination. Maximum number of results per page.

Default 10
offsetinteger(int64)

Offset used for pagination.

Default 0
curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/social-posts/templates?max=10&offset=0&userId=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Social Post Templates retrieved

Body*/*
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.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​countinteger(int32)

Count of social post templates

Example: 5
response.​socialPostTemplatesArray of objects(SocialPostTemplate)
Response
No content

Create a Social Post Template

Request

Create a new Social Post Template.

Body*/*required

The Social Post Template to create

titlestring

The title of the Social Post Template.

descriptionstring

The description of the Social Post Template. It is required if the template has no photos.

urlstring

A link for the Social Post Template.

typestringrequired

The type of the Social Post Template. POST, OFFER or QUESTION_AND_ANSWER, EVENT or ALERT.

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

Set to COVID_19 if this Social Post Template is a COVID-19 Google Alert Post

Value"COVID_19"
sharedboolean

Defines if the Social Post Template is shared or not.

isStoreLocatorboolean

When enabled, the SocialPost will be visible in StoreLocator

callToActionsArray of objects(SocialPostTemplateCallToAction)

Social Post Call to Action Description (URL & Type)

directoriesArray of strings
Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
ownerIdinteger(int64)

The id of the user that owns the Social Post Template. (Only informational. If included in the request, it will be ignored.)

ownerNamestring

The name of the user that owns the Social Post Template. (Only informational. If included in the request, it will be ignored.)

videosArray of strings

List of videos (currently only supports one element)

userIdinteger(int64)required

Id of the user that is doing the action

photosArray of objects(PhotoContainer)

The Social Post Template's photos. It should be a list containing BASE64 converted images or urls of photos from a previous Social Post. It is required if the template has no description.

curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/social-posts/templates \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Social Post Template created

Body*/*
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.​socialPostTemplateobject

Social Post Template Model

Response
No content

Get all or several Social Post Templates

Request

Get a Social Plan Template identified by its unique uberall ID.

Path
idstringrequired

Id of the Social Post Template

Query
userIdstring

Id of the user requesting the social post template

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/social-posts/templates/{id}?userId=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Social Post Template retrieved

Body*/*
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.​socialPostTemplateobject

Social Post Template Model

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

Menu Items

Locations Hub - Locations - Menu Items

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