Publish or withdraw an Extension

PUT/contributors/{contributorId}/extensions/{extensionId}/published/

API version

v2

Request method

PUT

Operation ID

extension-set-extension-published-state

---

Request

• contributorIdstring

  required
• extensionIdstring (uuid)

  required

Responses

Format

application/json

Description

The Extension visibility has been adjusted.

Schema documentation

• idstring (uuid)

  required
• publishedboolean

  required

Example

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "published": true
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "published": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "published"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PUT \
    -d '{"published":true,"reason":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/contributors/string/extensions/f0f86186-0a5a-45b2-aa33-502777496347/published

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.marketplace.extensionSetExtensionPublishedState({
  "contributorId": "string",
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "published": true,
    "reason": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionSetExtensionPublishedState\ExtensionSetExtensionPublishedStateRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionSetExtensionPublishedState\ExtensionSetExtensionPublishedStateRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new ExtensionSetExtensionPublishedStateRequest(
  contributorId: "string",
  extensionId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->marketplace()->extensionSetExtensionPublishedState($request);

var_dump($response->getBody();