CLclubplatform
News

Single News

News are being processed asynchronously. When the request contains valid data the server responds with a status code 202. However, the news is not being exposed by the API until all images have been processed. So there might be some delay (depending on the size and total amount of the images) between the delivery and the publication via the api.

The first time a news entry is delivered with a new category, that category is put on a blacklist and has to be whitelisted in order to make it available through the API. To whitelist a category you must edit your app inside your organization.

The news body can contain any HTML elements. It is possible to include image elements and links to external sources like youtube. However you should make use of sending the images together with the components because it has some advantages:

  • The images are hosted by us, so if the original image source changes, the images used in the news entry are still available.
  • The images will be processed and available in different scaled sizes which are optimized for different use cases e.g. mobile devices.
post/clubs/{club_id}/news

Request

  • Base URL
    https://api.clubplatform.de/api
  • URL
    https://api.clubplatform.de/api/clubs/{club_id}/news
  • Auth
    API key in query parameter auth_token

Path parameters

club_idinteger required

ID of the club.

Request body

Example request

{
  "news": {
    "id": 42,
    "locale": "de-DE",
    "keywords": [
      "keyword"
    ],
    "author": "Borussia Dortmund",
    "url": "http://www.bvb.de/News/Uebersicht/Ich-will-erfolgreich-sein-und-guten-Fussball-spielen-lassen",
    "highlight": true,
    "prio": true,
    "category": "Nachricht",
    "category_id": 113,
    "additional_categories": [
      {
        "category": "Additional Category 1",
        "id": 17
      },
      {
        "category": "Additional Category 2",
        "id": 22
      }
    ],
    "teaser": {
      "title": "„Ich will erfolgreich sein und guten Fußball spielen lassen“",
      "text": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
      "text_original": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
      "images": [
        {
          "url": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
          "width": 1140,
          "height": 840,
          "orientation": "landscape",
          "size": {
            "small": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/small_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
            "medium": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/medium_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
            "large": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/large_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg"
          },
          "description": "Dezentes grinsen."
        }
      ]
    },
    "components": [
      {
        "title": "„Ich will erfolgreich sein und guten Fußball spielen lassen“",
        "subhead": "Neuer Trainer",
        "text": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
        "text_original": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
        "images": [
          {
            "url": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
            "width": 1140,
            "height": 840,
            "orientation": "landscape",
            "size": {
              "small": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/small_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
              "medium": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/medium_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
              "large": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/large_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg"
            },
            "description": "Dezentes grinsen."
          }
        ]
      }
    ],
    "ranking": 5,
    "send_as_notification": true
  }
}

Response

Created

idinteger

ID of the news.

localestring

Locale of the object. 'de-DE', 'en-GB' or 'nl-NL'. This locale must be whitelisted for your club!

keywordsstring[]

Array of keywords that describe the news.

authorstring

Author of the news.

urlstring required

URL of the original news.

highlightboolean

Special type of news.

prioboolean
categorystring required

Category of the news.

category_idinteger

Category ID of the news.

state'in_progress' | 'processed'
  • in_progress - Currently processing by the server.
  • processed - Processing is finished.
created_atstring date-time required

The UTC date/time at which the current object was created.

published_atstring date-time

The UTC date/time at which the news item was published.

rankinginteger

The value of ranking can be between 1 to 100 or null. If ranking_feature of this club is disabled it will always be null

send_as_notificationboolean

Example response

{
  "id": 42,
  "locale": "de-DE",
  "keywords": [
    "keyword"
  ],
  "author": "Borussia Dortmund",
  "url": "http://www.bvb.de/News/Uebersicht/Ich-will-erfolgreich-sein-und-guten-Fussball-spielen-lassen",
  "highlight": true,
  "prio": true,
  "category": "Nachricht",
  "category_id": 113,
  "additional_categories": [
    {
      "category": "Additional Category 1",
      "id": 17
    },
    {
      "category": "Additional Category 2",
      "id": 22
    }
  ],
  "teaser": {
    "title": "„Ich will erfolgreich sein und guten Fußball spielen lassen“",
    "text": "Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.",
    "text_original": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
    "images": [
      {
        "url": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
        "width": 1140,
        "height": 840,
        "orientation": "landscape",
        "size": {
          "small": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/small_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
          "medium": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/medium_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
          "large": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/large_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg"
        },
        "description": "Dezentes grinsen."
      }
    ]
  },
  "components": [
    {
      "title": "„Ich will erfolgreich sein und guten Fußball spielen lassen“",
      "subhead": "Neuer Trainer",
      "text": "Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.",
      "text_original": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
      "images": [
        {
          "url": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
          "width": 1140,
          "height": 840,
          "orientation": "landscape",
          "size": {
            "small": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/small_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
            "medium": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/medium_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
            "large": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/large_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg"
          },
          "description": "Dezentes grinsen."
        }
      ]
    }
  ],
  "ranking": 5,
  "send_as_notification": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.