Create DM message by participant ID

v1.0.0

Sends a new direct message to a specific participant by their ID.

Input

{
  "type": "object",
  "properties": {
    "attachments": {
      "type": "array",
      "description": "Attachments to include with the message.",
      "items": {
        "type": "object",
        "required": [
          "media_id"
        ],
        "properties": {
          "media_id": {
            "type": "string",
            "description": "A media id to attach to the message."
          }
        },
        "additionalProperties": false
      }
    },
    "participant_id": {
      "type": "string"
    },
    "text": {
      "type": "string",
      "description": "Text of the Direct Message."
    }
  },
  "required": [
    "participant_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "dm_conversation_id",
        "dm_event_id"
      ],
      "properties": {
        "dm_conversation_id": {
          "type": "string",
          "description": "The conversation the message was sent to."
        },
        "dm_event_id": {
          "type": "string",
          "description": "The id of the created DM event."
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}