Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/social-post-ideas/generate-observance-idea

Generate observance idea

Generates a post idea for a given observance/holiday for a brand. Optionally steer with an observanceDate and a hint.

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

Parameters

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Body

NameTypeRequiredDescription
socialProfileIdstringrequired
observanceNamestringrequired
observanceDatestringoptional
hintstringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/social-post-ideas/generate-observance-idea' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "socialProfileId": "6f1c2a90-...",
  "observanceName": "Earth Day"
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "generateObservanceIdea": {
      "success": true,
      "idea": {},
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.generateObservanceIdeaobjectoptional
data.generateObservanceIdea.successbooleanoptional
data.generateObservanceIdea.ideaobjectoptionalThe updated post idea (see Post idea for the full shape).
data.generateObservanceIdea.errorobjectoptional
data.generateObservanceIdea.error.messagestringoptional
data.generateObservanceIdea.error.codestringoptional
data.generateObservanceIdea.error.contextInfoarray of objectoptional
data.generateObservanceIdea.error.contextInfo[].keystringoptional
data.generateObservanceIdea.error.contextInfo[].valuestringoptional