Create a conversation

POST/conversations/

API version

v2

Request method

POST

Operation ID

conversation-create-conversation

---

Request

Responses

Format

application/json

Description

Schema documentation

• conversationIdstring (uuid)

  required

Example

Content-Type: application/json

{
  "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 POST \
    -d '{"categoryId":"string","mainUserId":"f0f86186-0a5a-45b2-aa33-502777496347","notificationRoles":["customer_owner"],"relatedTo":{"aggregate":"user","domain":"user","id":"string"},"sharedWith":{"aggregate":"user","domain":"user","id":"string"},"title":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/conversations

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.createConversation({
  "data": {
    "categoryId": "string",
    "mainUserId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "notificationRoles": [
      "customer_owner"
    ],
    "relatedTo": {
      "aggregate": "user",
      "domain": "user",
      "id": "string"
    },
    "sharedWith": {
      "aggregate": "user",
      "domain": "user",
      "id": "string"
    },
    "title": "string"
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Conversation\CreateConversation\CreateConversationRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Conversation\CreateConversation\CreateConversationRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new CreateConversationRequest(
  body: $body
));
$response = $client->conversation()->createConversation($request);

var_dump($response->getBody();