Private Messages
Private messages are Fimfiction's way of letting users send messages...in private!
Relevant Scopes
read_pmswrite_pms
Table of Contents
Get a list of private messages for :id. At least one of the sent and received filters must be set to true, otherwise there would be nothing to send back! Can only view messages sent or received the authenticated user. Because of this, you can use this endpoint to effectively view a conversation between the authenticated user and :id.
Returns
[ private_message ]
Scopes
- read_pms - Required
Parameters
| :id required | The user id to fetch PMs for. Can be set as me for the authenticated user |
Filters
|
sender
sender_id(int)
|
Filter out messages not sent from sender_id |
|
subject
text(string)
|
Filter out stories that do not contain text in the subject |
|
content
text(string)
|
Filter out stories that do not contain text in the content |
|
date_sent
minimum(date),maximum(date)
|
Filter out messages posted before minimum or after maximum |
|
read
read(bool)
|
Filter out messages where the read status is not equal to read |
|
sent
sent(bool)
|
Whether to include messages sent by the authenticated user (defaults to false) |
|
received
received(bool)
|
Whether to include messages received by the authenticated user (defaults to true) |
Sort
|
read
|
Whether the message is read (1) or unread (0) |
|
date_sent
|
When the message was sent |
Pagination
- Default Size: 100
- Maximum Size: 1000
- Type: page
Get a private messages by id. You can only view messages sent or received by the authenticated user.
Returns
Scopes
- read_pms - Required
Parameters
| :id required | ID of the message |
Send a private message from the authenticated user to :id
Returns
Body
Scopes
- write_pms - Required