POSTapi.synup.com/api/v4/local-post-ideas/update-idea

Update local idea

Updates an existing post idea's editable fields — title, content, status, call-to-action, scheduling, bucket, note, and target platforms. Only the fields you send are changed.

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
`ideaId`	string	required
`title`	string	optional
`content`	string	optional
`status`	string	optional
`ctaText`	string	optional
`ctaUrl`	string	optional
`scheduledDate`	string	optional
`scheduledTime`	string	optional
`bucket`	string	optional
`note`	string	optional
`platforms`	array of string	optional

Request

curl -X POST 'https://api.synup.com/api/v4/local-post-ideas/update-idea' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ideaId": "91b2...",
  "title": "Weekend Sale!",
  "status": "scheduled",
  "scheduledDate": "2026-05-01"
}'

const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/update-idea', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ideaId": "91b2...",
    "title": "Weekend Sale!",
    "status": "scheduled",
    "scheduledDate": "2026-05-01"
  }),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/local-post-ideas/update-idea",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
      "ideaId": "91b2...",
      "title": "Weekend Sale!",
      "status": "scheduled",
      "scheduledDate": "2026-05-01"
    },
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/local-post-ideas/update-idea", 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": {
    "updateLocalIdea": {
      "success": true,
      "idea": {},
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.updateLocalIdea`	object	optional
`data.updateLocalIdea.success`	boolean	optional
`data.updateLocalIdea.idea`	object	optional	The updated post idea (see Local post idea for the full shape).
`data.updateLocalIdea.error`	object	optional
`data.updateLocalIdea.error.message`	string	optional
`data.updateLocalIdea.error.code`	string	optional
`data.updateLocalIdea.error.contextInfo`	array of object	optional
`data.updateLocalIdea.error.contextInfo[].key`	string	optional
`data.updateLocalIdea.error.contextInfo[].value`	string	optional