Update the description of a delivery box

PATCH/delivery-boxes/{deliveryBoxId}/description/

API version

v2

Request method

PATCH

Operation ID

mail-update-delivery-box-description

---

Request

• deliveryBoxIdstring (uuid)

  required

  ID of the DeliveryBox to update the description for.

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PATCH \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/delivery-boxes/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.updateDeliveryBoxDescription({
  "deliveryBoxId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Mail\UpdateDeliveryBoxDescription\UpdateDeliveryBoxDescriptionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Mail\UpdateDeliveryBoxDescription\UpdateDeliveryBoxDescriptionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new UpdateDeliveryBoxDescriptionRequest(
  deliveryBoxId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->mail()->updateDeliveryBoxDescription($request);

var_dump($response->getBody();