RSS feeds

Update an RSS feed

Changes only the fields sent. The URL cannot change. The feed then posts as the key's member, so the key needs the permission of the resulting post mode, plus posts.others when someone else set the feed up. Requires the posts.draft permission.

patch/rss-feeds/{id}

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/rss-feeds/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

RSS feed ID

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

namestring

Defaults to the feed's title

postMode'DRAFT' | 'SCHEDULE' | 'PUBLISH'

DRAFT creates a draft and needs posts.draft; SCHEDULE schedules the post publishDelayMinutes after the item is found and needs posts.schedule; PUBLISH publishes it right away and needs posts.publish

publishDelayMinutesinteger

Required when postMode is SCHEDULE

contentMode'TEMPLATE' | 'AI'

TEMPLATE fills template; AI writes one caption per platform from the article, appends the link, spends 1 AI credit per platform per item and needs ai.generate

templatestring

Post text with {title}, {link}, {description}, {author} and {feed}. The description, then the title, is shortened to fit each platform; the link is never cut

aiInstructionsstring

Extra instructions for AI captions

includeImageboolean

Attach the item's image, or the article's preview image

twitterKeepLinksboolean

Keep links in X posts clickable. Lifetime-deal plans only; each X post with a link then costs more credits. Without it, links on X go out as plain text

includeKeywordsstring[]

Post only items whose title or summary contains one of these

excludeKeywordsstring[]

Skip items whose title or summary contains one of these

maxPostsPerCheckinteger

New items are posted oldest first; the rest wait for the next check

checkIntervalMinutes15 | 30 | 60 | 180 | 360 | 720 | 1440

Response

The updated RSS feed

idstring
userIdstring

Member the feed posts as: whoever last saved it

accountGroupIdstring
namestring
urlstring
siteUrlstring
status'ACTIVE' | 'PAUSED'
pauseReason'USER' | 'FETCH_FAILURES' | 'CONSECUTIVE_FAILURES' | 'ACCESS_LOST' | 'SUBSCRIPTION_INACTIVE' | 'CONNECTION_REMOVED'

Why the feed stopped: USER (paused by hand), FETCH_FAILURES (5 failed fetches in a row), CONSECUTIVE_FAILURES (3 items in a row failed to post), ACCESS_LOST (its owner lost the permission its post mode needs), SUBSCRIPTION_INACTIVE (the plan no longer covers publishing) or CONNECTION_REMOVED (every target account was disconnected)

lastErrorstring
postMode'DRAFT' | 'SCHEDULE' | 'PUBLISH'

DRAFT creates a draft and needs posts.draft; SCHEDULE schedules the post publishDelayMinutes after the item is found and needs posts.schedule; PUBLISH publishes it right away and needs posts.publish

publishDelayMinutesinteger
contentMode'TEMPLATE' | 'AI'

TEMPLATE fills template; AI writes one caption per platform from the article, appends the link, spends 1 AI credit per platform per item and needs ai.generate

templatestring
aiInstructionsstring
includeImageboolean
twitterKeepLinksboolean
includeKeywordsstring[]
excludeKeywordsstring[]
maxPostsPerCheckinteger
checkIntervalMinutesinteger
nextCheckAtstring date-time
lastCheckedAtstring date-time
lastPostedAtstring date-time
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 2 revisions of this API.