Sign in
Social Posting

Create a Social Post

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.

post/social-posts

Request body

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

type'POST' | 'OFFER' | 'ALERT' | 'EVENT' | 'QUESTION_AND_ANSWER' | 'REEL' | 'STORY' | 'CAROUSEL' required

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

alertType'COVID_19'

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

idinteger

Id

campaignIdinteger

The campaign ID this Social Post belongs to

status'SCHEDULED' | 'APPROVAL_NEEDED' | 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'IMPOSSIBLE' | 'INCOMPLETE' | 'ENDED' | 'REJECTED'

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

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'

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

productPriceMininteger

Minimum product price

productPriceMaxinteger

Maximum product price

productCurrency'EUR' | 'USD' | 'GBP' | 'CHF' | 'AUD' | 'RUB' | 'JPY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

Currency of the product price

labelsstring[]

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

firstCommentstring

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

statusPerDirectoryobject
publicationsCountinteger

Publications count

directoriesstring[] required

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

Example request

{
  "publicationDate": "2024-06-25T11:01:00Z",
  "timeZone": "Europe/Berlin"
}

Response

Social Posts created.

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "response": {
      "socialPost": {
        "publicationDate": "2024-06-25T11:01:00Z",
        "timeZone": "Europe/Berlin"
      }
    }
  }
}

Changes

No changes recorded. 2 of the 14 revisions have no diff computed, so they could not be searched.