Private Messages

Creates a new topic, a new post, or a private message

POST

https://discourse.example.com/posts.json

curl -X POST 'https://discourse.example.com/posts.json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "title": "string",
  "raw": "string",
  "topic_id": 0,
  "category": 0,
  "target_recipients": "blake,sam",
  "target_usernames": "string",
  "archetype": "private_message",
  "created_at": "string",
  "reply_to_post_number": 0,
  "embed_url": "string",
  "external_id": "string",
  "auto_track": true
}'

const body = `{
  "title": "string",
  "raw": "string",
  "topic_id": 0,
  "category": 0,
  "target_recipients": "blake,sam",
  "target_usernames": "string",
  "archetype": "private_message",
  "created_at": "string",
  "reply_to_post_number": 0,
  "embed_url": "string",
  "external_id": "string",
  "auto_track": true
}`;

const response = await fetch('https://discourse.example.com/posts.json', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "title": "string",
  "raw": "string",
  "topic_id": 0,
  "category": 0,
  "target_recipients": "blake,sam",
  "target_usernames": "string",
  "archetype": "private_message",
  "created_at": "string",
  "reply_to_post_number": 0,
  "embed_url": "string",
  "external_id": "string",
  "auto_track": true
}'''

response = requests.post(
    'https://discourse.example.com/posts.json',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "title": "string",
  "raw": "string",
  "topic_id": 0,
  "category": 0,
  "target_recipients": "blake,sam",
  "target_usernames": "string",
  "archetype": "private_message",
  "created_at": "string",
  "reply_to_post_number": 0,
  "embed_url": "string",
  "external_id": "string",
  "auto_track": true
}

200

{
  "id": 0,
  "name": "string",
  "username": "string",
  "avatar_template": "string",
  "created_at": "string",
  "raw": "string",
  "cooked": "string",
  "post_number": 0,
  "post_type": 0,
  "posts_count": 0,
  "updated_at": "string",
  "reply_count": 0,
  "reply_to_post_number": "string",
  "quote_count": 0,
  "incoming_link_count": 0,
  "reads": 0,
  "readers_count": 0,
  "score": 0,
  "yours": true,
  "topic_id": 0,
  "topic_slug": "string",
  "display_username": "string",
  "primary_group_name": "string",
  "flair_name": "string",
  "flair_url": "string",
  "flair_bg_color": "string",
  "flair_color": "string",
  "flair_group_id": 0,
  "badges_granted": [],
  "version": 0,
  "can_edit": true,
  "can_delete": true,
  "can_recover": true,
  "can_see_hidden_post": true,
  "can_wiki": true,
  "user_title": "string",
  "bookmarked": true,
  "actions_summary": [
    {
      "id": 0,
      "can_act": true
    }
  ],
  "moderator": true,
  "admin": true,
  "staff": true,
  "user_id": 0,
  "draft_sequence": 0,
  "hidden": true,
  "trust_level": 0,
  "deleted_at": "string",
  "user_deleted": true,
  "edit_reason": "string",
  "can_view_edit_history": true,
  "wiki": true,
  "reviewable_id": 0,
  "reviewable_score_count": 0,
  "reviewable_score_pending_count": 0,
  "post_url": "string",
  "post_localizations": [],
  "mentioned_users": []
}

Body

application/json

titlestring

Required if creating a new topic or new private message.

rawstringrequired

topic_idinteger

Required if creating a new post.

categoryinteger

Optional if creating a new topic, and ignored if creating a new post.

target_recipientsstring

Required for private message, comma separated.

Example

blake,sam

target_usernamesstringdeprecated

Deprecated. Use target_recipients instead.

archetypestring

Required for new private message.

Example

private_message

created_atstring

reply_to_post_numberinteger

Optional, the post number to reply to inside a topic.

embed_urlstring

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.

external_idstring

Provide an external_id from a remote system to associate a forum topic with that id.

auto_trackboolean

If false, the user will not track the topic. By default, the user will track the topic.

Response

200OKany

post created

Response fields application/json

idintegerrequired

namestring | nullrequired

usernamestringrequired

avatar_templatestringrequired

created_atstringrequired

rawstring

cookedstringrequired

post_numberintegerrequired

post_typeintegerrequired

posts_countintegerrequired

updated_atstringrequired

reply_countintegerrequired

reply_to_post_numberstring | nullrequired

quote_countintegerrequired

incoming_link_countintegerrequired

readsintegerrequired

readers_countintegerrequired

scorenumberrequired

yoursbooleanrequired

topic_idintegerrequired

topic_slugstringrequired

display_usernamestring | nullrequired

primary_group_namestring | nullrequired

flair_namestring | nullrequired

flair_urlstring | nullrequired

flair_bg_colorstring | nullrequired

flair_colorstring | nullrequired

flair_group_idinteger | null

badges_grantedArray<any>

versionintegerrequired

can_editbooleanrequired

can_deletebooleanrequired

can_recoverbooleanrequired

can_see_hidden_postboolean

can_wikibooleanrequired

user_titlestring | nullrequired

bookmarkedbooleanrequired

actions_summaryArray<object>required

Show child attributes

idintegerrequired

can_actbooleanrequired

moderatorbooleanrequired

adminbooleanrequired

staffbooleanrequired

user_idintegerrequired

draft_sequenceintegerrequired

hiddenbooleanrequired

trust_levelintegerrequired

deleted_atstring | nullrequired

user_deletedbooleanrequired

edit_reasonstring | nullrequired

can_view_edit_historybooleanrequired

wikibooleanrequired

reviewable_idinteger | nullrequired

reviewable_score_countintegerrequired

reviewable_score_pending_countintegerrequired

post_urlstringrequired

post_localizationsArray<any>

mentioned_usersArray<any>

Docs by Sourcey