POSTapi.synup.com/api/v4/social-post-ideas/generate-holiday-idea-variant
Generate holiday idea variant
Generates a new post-idea variant for a given observance/holiday for a brand. Optionally steer with an observanceDate and topic.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Synup-Version | string | required | API version date (YYYY-MM-DD). |
Body
| Name | Type | Required | Description |
|---|---|---|---|
socialProfileId | string | required | |
observanceName | string | required | |
observanceDate | string | optional | |
topic | string | optional |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/social-post-ideas/generate-holiday-idea-variant' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"socialProfileId": "6f1c2a90-...",
"observanceName": "Black Friday"
}'const res = await fetch('https://api.synup.com/api/v4/social-post-ideas/generate-holiday-idea-variant', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"socialProfileId": "6f1c2a90-...",
"observanceName": "Black Friday"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/social-post-ideas/generate-holiday-idea-variant",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"socialProfileId": "6f1c2a90-...",
"observanceName": "Black Friday"
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/social-post-ideas/generate-holiday-idea-variant", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
401 | Unauthorized - Invalid or missing API key |
Example response (generated from the schema)
{
"data": {
"generateHolidayIdeaVariant": {
"success": true,
"idea": {},
"error": {
"message": "string",
"code": "string",
"contextInfo": [
{
"key": "string",
"value": "string"
}
]
}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.generateHolidayIdeaVariant | object | optional | |
data.generateHolidayIdeaVariant.success | boolean | optional | |
data.generateHolidayIdeaVariant.idea | object | optional | The updated post idea (see Post idea for the full shape). |
data.generateHolidayIdeaVariant.error | object | optional | |
data.generateHolidayIdeaVariant.error.message | string | optional | |
data.generateHolidayIdeaVariant.error.code | string | optional | |
data.generateHolidayIdeaVariant.error.contextInfo | array of object | optional | |
data.generateHolidayIdeaVariant.error.contextInfo[].key | string | optional | |
data.generateHolidayIdeaVariant.error.contextInfo[].value | string | optional |