X (Twitter) · Schema

CreateDmConversationRequest

CreateDmConversationRequest schema from X API v2

Social MediaMicrobloggingReal-Time DataStreamingAdvertisingContent

Properties

Name Type Description
conversation_type string The conversation type that is being created.
message object
participant_ids array Participants for the DM Conversation.
View JSON Schema on GitHub

JSON Schema

x-api-create-dm-conversation-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twitter/refs/heads/main/json-schema/x-api-create-dm-conversation-request-schema.json",
  "title": "CreateDmConversationRequest",
  "description": "CreateDmConversationRequest schema from X API v2",
  "type": "object",
  "properties": {
    "conversation_type": {
      "type": "string",
      "description": "The conversation type that is being created.",
      "enum": [
        "Group"
      ]
    },
    "message": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/CreateTextMessageRequest"
        },
        {
          "$ref": "#/components/schemas/CreateAttachmentsMessageRequest"
        }
      ]
    },
    "participant_ids": {
      "type": "array",
      "description": "Participants for the DM Conversation.",
      "minItems": 2,
      "maxItems": 49,
      "items": {
        "$ref": "#/components/schemas/UserId"
      }
    }
  },
  "required": [
    "conversation_type",
    "participant_ids",
    "message"
  ],
  "additionalProperties": false
}