discoursejs/docs/sdk/models/operations/createtopicpostpmrequestbody.md

CreateTopicPostPMRequestBody

Example Usage

import { CreateTopicPostPMRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";

let value: CreateTopicPostPMRequestBody = {
    archetype: "private_message",
    raw: "<value>",
    targetRecipients: "blake,sam",
};

Fields

Field	Type	Required	Description	Example
archetype	string	➖	Required for new private message.	private_message
category	number	➖	Optional if creating a new topic, and ignored if creating a new post.
createdAt	string	➖	N/A
embedUrl	string	➖	Provide a URL from a remote system to associate a forum topic with that URL, typically for using Discourse as a comments system for an external blog.
externalId	string	➖	Provide an external_id from a remote system to associate a forum topic with that id.
raw	string	✔️	N/A
replyToPostNumber	number	➖	Optional, the post number to reply to inside a topic.
targetRecipients	string	➖	Required for private message, comma separated.	blake,sam
targetUsernames	string	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Deprecated. Use target_recipients instead.
title	string	➖	Required if creating a new topic or new private message.
topicId	number	➖	Required if creating a new post.