Update the status of a conversation

PUT/conversations/{conversationId}/status/

API version

v2

Request method

PUT

Operation ID

conversation-set-conversation-status

---

Request

• conversationIdstring (uuid)

  required

Responses

Format

application/json

Beschreibung

Schema-Dokumentation

• conversationIdstring (uuid)

  required

Beispiel

{
  "conversationId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "conversationId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "conversationId"
  ],
  "type": "object"
}

Usage examples

cURL

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

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.conversation.setConversationStatus({
  "conversationId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Conversation\SetConversationStatus\SetConversationStatusRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Conversation\SetConversationStatus\SetConversationStatusRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new SetConversationStatusRequest(
  conversationId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->conversation()->setConversationStatus($request);

var_dump($response->getBody();