Feeds

Feeds are used to collect posts across a number of social media networks into a single channel that can be integrated into a widget, displayed on your website, displayed on a digital TV, queried via an API, et cetera, et cetera, and so forth.

List Feeds

Returns a list of the Feeds

GET /feeds

Request

GET /v1/feeds

Response

[
    {
        "id": "660b923a-a6e7-4540-bd03-7e08fd006e0d",
        "moderation": "post",
        "name": "Default",
        "colour_body_bg": "#efefef",
        "colour_body_text": "#707070",
        "colour_header_bg": "#efefef",
        "colour_header_text": "#2B2B2B",
        "public_key": "adfdad0b-88ea-4660-8fc5-6ab02741"
    }
]

Create Feed

Creates a Feed

POST /feeds

Request

POST /v1/feeds

{
    "name": "My feed"
}

Response

{ 
    "id": "315181d5-4f15-40bc-b2a0-0dd196caa13a",
    "public_key": "0b3057fb-80c3-4c0f-8af8-590274dbfbd0",
    "moderation": "post",
    "name": "My feed",
    "colour_body_bg": "#efefef",
    "colour_body_text": "#707070",
    "colour_header_bg": "#efefef",
    "colour_header_text": "#2B2B2B"
}

Params

Param Description Required
name Internal name of the Feed Yes

Update Feed

Update a Feed

POST /feeds/FEED_ID

Request

POST /v1/feeds/FEED_ID

{ 
    "name": "Default",
    "moderation": "post",
    "colour_body_bg": "#efefef",
    "colour_body_text": "#707070",
    "colour_header_bg": "#efefef",
    "colour_header_text": "#2B2B2B",
}

Response

{
    "id": "705da60d-4479-4696-b49b-29bca98d920d",
    "name": "Default",
    "moderation": "post",
    "colour_body_bg": "#efefef",
    "colour_body_text": "#707070",
    "colour_header_bg": "#efefef",
    "colour_header_text": "#2B2B2B",
    "public_key": "19c614db-c1d1-4111-af53-82f3765a"
}

Params

Param Description
FEED_ID Id of Feed to update
name Name of feed - only displayed in the admin
moderation Moderation the feed will use - post or pre
colour_body_bg Body background colour to use for widget
colour_body_text Body text color to use for widget
colour_header_bg Header background colour to use for widget
colour_header_text Header text colour to use for widget

Delete Feed

Removes a Feed.

Note: Deleting a feed will remove all associated sources and posts.

DELETE /feeds/FEED_ID

Request

DELETE /v1/feeds/FEED_ID

Response

{
   "success":true,
   "message":"Feed deleted"
}

Params

Param Description Required
FEED_ID ID of Feed to delete Yes