Submit your usage of the spotlight

POST/v2/users/self/spotlights/{spotlightId}/

API version

v2

Request method

POST

Operation ID

user-spotlight-usage

---

Request

• spotlightIdstring

  required

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"acknowledged":true,"owner":"string","used":true}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/self/spotlights/string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.spotlightUsage({
  "spotlightId": "string",
  "data": {
    "acknowledged": true,
    "owner": "string",
    "used": true
  }
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\SpotlightUsage\SpotlightUsageRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\SpotlightUsage\SpotlightUsageRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// SpotlightUsageRequestBody to learn how to construct a valid instance
$body = new SpotlightUsageRequestBody(/* TODO: ... */);

$request = (new SpotlightUsageRequest(
  spotlightId: "string",
  body: $body
));
$response = $client->user()->spotlightUsage($request);

var_dump($response->getBody();