Synupv1
Create a key
v1Resources/Post Ideas/patchUpdate a post idea

Update a post idea

Updates a post idea's editable fields. id accepts either its own id or the external id it was created with.

patch/api/v1/post-ideas/{id}
ideas:write
Query parameters
idstringrequired
The post idea to update — its id or externalId.
Request body
titlestringoptional
The idea's title. Required on create.
contentstringoptional
The idea's caption/body content.
imageUrlstringoptional
URL of an image to attach to the idea.
imagePromptstringoptional
The prompt used to generate the idea's image.
typestring (announcement | offer | tip | showcase | story | event)optional
Idea type.
statusstring (draft | published | archived)optional
Idea status.
platformsarray of stringoptional
Platforms this idea is intended for.
scheduledDatestringoptional
Planned publish date (YYYY-MM-DD).
scheduledTimestringoptional
Planned publish time.
Response
dataobjectoptional
idstringoptional
Unique identifier for the post idea.
locationIdstringoptional
ID of the location this idea belongs to, or null for a brand-level idea.
clientLocationIdstringoptional
Resolved location record id, or null.
clientIdstringoptional
ID of the client this idea belongs to (brand-level ideas), or null.
brandNamestringoptional
Brand profile display name, for brand-level ideas, or null.
titlestringoptional
The idea's title.
contentstringoptional
The idea's caption/body content.
imageUrlstringoptional
URL of the idea's image, or null.
imagePromptstringoptional
The prompt used to generate the idea's image, or null.
typestring (announcement | offer | tip | showcase | story | event)optional
Idea type: announcement, offer, tip, showcase, story, or event.
statusstring (draft | published | archived)optional
Idea status: draft, published, or archived.
bucketstring (idea | holiday | calendar | series)optional
Which grid bucket the idea sits in: idea, holiday, calendar, or series.
platformsarray of stringoptional
Platforms this idea is intended for.
seriesIdstringoptional
ID of the content series this idea belongs to, or null.
scheduledDatestringoptional
Planned publish date (YYYY-MM-DD), or null.
scheduledTimestringoptional
Planned publish time, or null.
externalIdstringoptional
Stable id this idea was created with, if it came from an external source.
sourcestring (os | agent)optional
Where the idea came from: os (created in Synup) or agent (pushed by an AI agent).
reviewStatusstring (pending | approved | rejected)optional
Approval gate: null (no gate), pending, approved, or rejected.
generationJobIdstringoptional
ID of the AI generation job that produced this idea, if any, or null.
isUserGeneratedbooleanoptional
Whether a person (rather than an agent) created this idea.
archivedbooleanoptional
Whether this idea has been archived.
archivedAtstringoptional
When this idea was archived, as an ISO 8601 timestamp, or null.
createdAtstringoptional
When this idea was created, as an ISO 8601 timestamp.
updatedAtstringoptional
When this idea was last updated, as an ISO 8601 timestamp.
locationNamestringoptional
Display name of the idea's location. Only present when listing a client's location-scoped ideas.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
patch/api/v1/post-ideas/{id}
Your API key
id *
Request body
{
  "data": {
    "id": "cm_idea_abc123",
    "agencyId": "cm_agency_1",
    "locationId": "cm_loc_1",
    "clientLocationId": "cm_loc_1",
    "clientId": null,
    "brandName": null,
    "agentMeta": null,
    "title": "Spotlight our new patient special (updated)",
    "content": "Book this month and get 25% off your first cleaning!",
    "imagePrompt": null,
    "imageUrl": null,
    "type": "announcement",
    "status": "draft",
    "bucket": "idea",
    "platforms": [
      "google",
      "facebook"
    ],
    "seriesId": null,
    "scheduledDate": null,
    "scheduledTime": null,
    "observanceName": null,
    "observanceDate": null,
    "generationBatchId": null,
    "generationJobId": null,
    "isUserGenerated": true,
    "source": "os",
    "externalId": "cm_idea_abc123",
    "reviewStatus": null,
    "archived": false,
    "archivedAt": null,
    "createdAt": "2026-01-20T09:00:00.000Z",
    "updatedAt": "2026-01-20T09:05:00.000Z"
  }
}