Self Service

POST /client/{client_id}/teasers/{teaser_id}

Requires authentication with server or user access token.

Update teasers for client.

Help us improve

Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.

Request

POST /api/2/client/{client_id}/teasers/{teaser_id}

client_id

required path parameter

Client ID

teaser_id

required path parameter

Client Teaser ID

description

optional

markdown

optional

css

optional

active

optional

slug

optional

Example request

cURL
Minimal example
curl https://login.schibsted.com/api/2/client/4321abc00000000000000000/teasers/123123 \
   -X POST \
   -d "oauth_token=[access token]"
With all parameters
curl https://login.schibsted.com/api/2/client/4321abc00000000000000000/teasers/123123 \
   -X POST \
   -d "oauth_token=[access token]" \
   -d "description=Some information" \
   -d "markdown=# Markdown" \
   -d "css=body { color: #c00; }" \
   -d "active=true" \
   -d "slug=default"
Java
Minimal example
SpidOAuthToken token = spidClient.getUserToken(code);
String responseJSON = spidClient.
    POST(token, "/client/4321abc00000000000000000/teasers/123123").
    getResponseBody();
With all parameters
Map<String, String> params = new HashMap<>() {{
    put("description", "Some information");,
    put("markdown", "# Markdown");,
    put("css", "body { color: #c00; }");,
    put("active", "true");,
    put("slug", "default");
}};

SpidOAuthToken token = spidClient.getUserToken(code);
String responseJSON = spidClient.
    POST(token, "/client/4321abc00000000000000000/teasers/123123", params).
    getResponseBody();

This example is an excerpt, see a full example

PHP
Minimal example
<?php
$client->auth();
echo var_dump($client->api("/client/4321abc00000000000000000/teasers/123123", "POST"));
With all parameters
<?php
$params = array(
    "description" => "Some information",
    "markdown" => "# Markdown",
    "css" => "body { color: #c00; }",
    "active" => "true",
    "slug" => "default"
);

$client->auth();
echo var_dump($client->api("/client/4321abc00000000000000000/teasers/123123", "POST", $params));

This example is an excerpt, see a full example

Clojure
Minimal example
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-user-token client "[code]")]
  (spid/POST client token "/client/4321abc00000000000000000/teasers/123123"))
With all parameters
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-user-token client "[code]")]
  (spid/POST client token "/client/4321abc00000000000000000/teasers/123123" {"description" "Some information"
                                                                             "markdown" "# Markdown"
                                                                             "css" "body { color: #c00; }"
                                                                             "active" "true"
                                                                             "slug" "default"}))

Response

This endpoint supports the JSON response format.

Success: 200 OK

Returns the updated teaser object

Teaser

Teaser object

id

string

Teaser ID

client_id

string

Client ID

description

string

Description of teaser

markdown

string

Teaser content in Markdown format

html

string

Teaser content in HTML format

css

string

Teaser css

filename

string

Filename of teaser

active

string

Flag if teaser is active or not

slug

string

Slug for teaser

updated

string

Time of last update

created

string

Time of creation

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 400 Bad Request Missing required parameters, or teaser not found
  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Token does not have access to this teaser
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 404 Not Found Client not found
  • 420 Request Ratelimit exceeded

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.