Skip to content
Letterhead Letterhead Letterhead Help Center
Admin Tools

Update a data feed

PATCH
/api/v3/curations/data-feeds/{feedUniqueId}
 
curl --request PATCH \
  --url 'https://api.tryletterhead.com/api/v3/curations/data-feeds/example?api=true' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "description": "example", "feedUrl": "example", "archiveIntervalDays": 1, "tags": [ "example" ], "channels": [ 1 ], "fieldMappings": [ { "source": "example", "target": "example" } ], "authType": 1, "bearerToken": "example" }'

Update an existing company-level JSON data feed. This endpoint replaces the feed’s full set of fields — every property required on Create a data feed must be supplied again, not just the ones changing. An omitted bearerToken on an authType: 1 feed keeps the credential already stored.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
feedUniqueId
required
string

The data feed’s unique identifier, from List data feeds.

Query Parameters

Section titled “Query Parameters ”
api
required
boolean

Required. Set to true to authenticate with your company API key rather than a signed-in session.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
title
required
string
description
required
string
feedUrl
required
string
archiveIntervalDays
required
integer
tags
Array<string>
channels
Array<integer>
fieldMappings
required
Array<object>
>= 1 items
object
source
required
string
target
required
string
authType
required
integer
bearerToken
string
Example generated
{
  "title": "example",
  "description": "example",
  "feedUrl": "example",
  "archiveIntervalDays": 1,
  "tags": [
    "example"
  ],
  "channels": [
    1
  ],
  "fieldMappings": [
    {
      "source": "example",
      "target": "example"
    }
  ],
  "authType": 1,
  "bearerToken": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Data feed updated

Media type application/json
object
items

The shape returned for both RSS feeds (List curation feeds) and JSON data feeds (List data feeds) — type (0 RSS, 1 JSON data feed) tells the two apart. fieldMappings, authType, and hasAuthSecret are only meaningful on a JSON data feed.

object
uniqueId
string
title
string
description
string
feedUrl
string
type

0 RSS feed, 1 JSON data feed.

integer
isValid
boolean
validationCode
integer
nullable
crawl
boolean
archiveIntervalDays
integer
lastValidated
string
lastQueried
string
channelName

The channel this feed was originally created against, or blank for a feed shared to multiple channels with no single owner.

string
channelSlug
string
sharedChannelIds

Internal numeric identifiers of every channel this feed is shared with.

Array<integer>
tags
Array<string>
authType

0 — no authentication. 1 — bearer token.

integer
hasAuthSecret

Whether a credential is stored — the credential itself is never returned.

boolean
fieldMappings
Array<object>
object
source
string
target
string
createdAt
string
updatedAt
string
deletedAt
string
nullable
message
string
total
integer
Example generated
{
  "items": {
    "uniqueId": "example",
    "title": "example",
    "description": "example",
    "feedUrl": "example",
    "type": 1,
    "isValid": true,
    "validationCode": 1,
    "crawl": true,
    "archiveIntervalDays": 1,
    "lastValidated": "example",
    "lastQueried": "example",
    "channelName": "example",
    "channelSlug": "example",
    "sharedChannelIds": [
      1
    ],
    "tags": [
      "example"
    ],
    "authType": 1,
    "hasAuthSecret": true,
    "fieldMappings": [
      {
        "source": "example",
        "target": "example"
      }
    ],
    "createdAt": "example",
    "updatedAt": "example",
    "deletedAt": "example"
  },
  "message": "example",
  "total": 1
}

Still can’t find what you need? Contact support.