mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-06 12:27:48 +00:00
29 lines
11 KiB
Markdown
29 lines
11 KiB
Markdown
# CreateTopicPostPMRequestBody
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
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* | :heavy_minus_sign: | Required for new private message. | private_message |
|
|
| `category` | *number* | :heavy_minus_sign: | Optional if creating a new topic, and ignored if creating a new post. | |
|
|
| `createdAt` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `embedUrl` | *string* | :heavy_minus_sign: | 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* | :heavy_minus_sign: | Provide an external_id from a remote system to associate a forum topic with that id. | |
|
|
| `raw` | *string* | :heavy_check_mark: | N/A | |
|
|
| `replyToPostNumber` | *number* | :heavy_minus_sign: | Optional, the post number to reply to inside a topic. | |
|
|
| `targetRecipients` | *string* | :heavy_minus_sign: | Required for private message, comma separated. | blake,sam |
|
|
| ~~`targetUsernames`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated. Use target_recipients instead. | |
|
|
| `title` | *string* | :heavy_minus_sign: | Required if creating a new topic or new private message. | |
|
|
| `topicId` | *number* | :heavy_minus_sign: | Required if creating a new post. | | |