Update the description of an deliverybox

PUT/deliveryboxes/{id}/description/

warning

This operation is deprecated and should not be used anymore. Please refer to this operation's description for alternatives.

API version

v2

Request method

PUT

Operation ID

deprecated-mail-deliverybox-update-description

---

This operation is deprecated. Use the PATCH v2/delivery-boxes/{deliveryBoxId}/description endpoint instead.

Request

• idstring (uuid)

  required

  ID of the deliverybox

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PUT \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/deliveryboxes/f0f86186-0a5a-45b2-aa33-502777496347/description

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.mail.deprecatedMailDeliveryboxUpdateDescription({
  "id": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Mail\DeprecatedMailDeliveryboxUpdateDescription\DeprecatedMailDeliveryboxUpdateDescriptionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Mail\DeprecatedMailDeliveryboxUpdateDescription\DeprecatedMailDeliveryboxUpdateDescriptionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new DeprecatedMailDeliveryboxUpdateDescriptionRequest(
  id: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->mail()->deprecatedMailDeliveryboxUpdateDescription($request);

var_dump($response->getBody();