Private Messages v1

Reference for the Private Messages v1 endpoints on Roblox.

Base URL: https://privatemessages.roblox.com

Endpoints

Method	Path	Name
`GET`	`/v1/announcements`	`getAnnouncements`
`GET`	`/v1/announcements/metadata`	`getAnnouncementsMetadata`
`GET`	`/v1/messages`	`getMessages`
`GET`	`/v1/messages/:messageId`	`getMessagesMessageid`
`POST`	`/v1/messages/archive`	`postMessagesArchive`
`POST`	`/v1/messages/mark-read`	`postMessagesMarkRead`
`POST`	`/v1/messages/mark-unread`	`postMessagesMarkUnread`
`POST`	`/v1/messages/unarchive`	`postMessagesUnarchive`
`GET`	`/v1/messages/unread/count`	`getMessagesUnreadCount`

`getAnnouncements`

GET /v1/announcements

Migrate from RobloxWebsite project, return news notification for Private Message page

Usage

import { fetchApi } from 'rozod';
import { getAnnouncements } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(getAnnouncements, undefined);

Response

Field	Type	Description
`collection`	`object[]`	See below
`totalCollectionSize`	`number`

collection[] item fields:

Field	Type	Description
`id`	`number`
`sender`	`object`	See below
`subject`	`string`
`body`	`string`
`created`	`string`
`updated`	`string`

sender fields:

Field	Type	Description
`hasVerifiedBadge`	`boolean`
`id`	`number`
`name`	`string`
`displayName`	`string`

Errors

Status	Description
400	2: Message does not exist or the current user is not authorized to view it.
401	0: Authorization has been denied for this request.

`getAnnouncementsMetadata`

GET /v1/announcements/metadata

Usage

import { fetchApi } from 'rozod';
import { getAnnouncementsMetadata } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(getAnnouncementsMetadata, undefined);

Response

Field	Type	Description
`numOfAnnouncements`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getMessages`

GET /v1/messages

Gets a user’s messages.

Usage

import { fetchApi } from 'rozod';
import { getMessages } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(getMessages, {
  pageNumber: /* integer? */,
  pageSize: /* integer? = 20 */,
  messageTab: /* enum */
});

Parameters

Name	Type	Required
`pageNumber`	`integer?`	No
`pageSize`	`integer? = 20`	No
`messageTab`	`enum`	Yes

Response

Field	Type	Description
`collection`	`object[]`	See below
`totalCollectionSize`	`number`
`totalPages`	`number`
`pageNumber`	`number`

collection[] item fields:

Field	Type	Description
`id`	`number`
`sender`	`object`	See below
`recipient`	`object`	See below
`subject`	`string`
`body`	`string`
`created`	`string`
`updated`	`string`
`isRead`	`boolean`
`isSystemMessage`	`boolean`
`isReportAbuseDisplayed`	`boolean`

sender fields:

Field	Type	Description
`hasVerifiedBadge`	`boolean`
`id`	`number`
`name`	`string`
`displayName`	`string`

recipient fields:

Field	Type	Description
`hasVerifiedBadge`	`boolean`
`id`	`number`
`name`	`string`
`displayName`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getMessagesMessageid`

GET /v1/messages/:messageId

Gets a message’s details.

Usage

import { fetchApi } from 'rozod';
import { getMessagesMessageid } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(getMessagesMessageid, {
  messageId: /* integer */
});

Parameters

Name	Type	Required	Description
`messageId`	`integer`	Yes

Response

Field	Type	Description
`id`	`number`
`sender`	`object`	See below
`recipient`	`object`	See below
`subject`	`string`
`body`	`string`
`created`	`string`
`updated`	`string`
`isRead`	`boolean`
`isSystemMessage`	`boolean`
`isReportAbuseDisplayed`	`boolean`

sender fields:

Field	Type	Description
`hasVerifiedBadge`	`boolean`
`id`	`number`
`name`	`string`
`displayName`	`string`

recipient fields:

Field	Type	Description
`hasVerifiedBadge`	`boolean`
`id`	`number`
`name`	`string`
`displayName`	`string`

Errors

Status	Description
400	2: Message does not exist or the current user is not authorized to view it.
401	0: Authorization has been denied for this request.

`postMessagesArchive`

POST /v1/messages/archive

Archives a batch of messages.

Usage

import { fetchApi } from 'rozod';
import { postMessagesArchive } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(postMessagesArchive, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`messageIds`	`number[]`

Response

Field	Type	Description
`failedMessages`	`object[]`	See below

failedMessages[] item fields:

Field	Type	Description
`messageId`	`number`
`errorMessage`	`string`

Errors

Status	Description
400	5: Too many ids in a batch request.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postMessagesMarkRead`

POST /v1/messages/mark-read

Marks a batch of messages as read.

Usage

import { fetchApi } from 'rozod';
import { postMessagesMarkRead } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(postMessagesMarkRead, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`messageIds`	`number[]`

Response

Field	Type	Description
`failedMessages`	`object[]`	See below

failedMessages[] item fields:

Field	Type	Description
`messageId`	`number`
`errorMessage`	`string`

Errors

Status	Description
400	5: Too many ids in a batch request.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postMessagesMarkUnread`

POST /v1/messages/mark-unread

Marks a batch of messages as unread.

Usage

import { fetchApi } from 'rozod';
import { postMessagesMarkUnread } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(postMessagesMarkUnread, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`messageIds`	`number[]`

Response

Field	Type	Description
`failedMessages`	`object[]`	See below

failedMessages[] item fields:

Field	Type	Description
`messageId`	`number`
`errorMessage`	`string`

Errors

Status	Description
400	5: Too many ids in a batch request.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postMessagesUnarchive`

POST /v1/messages/unarchive

Unarchives a batch of messages.

Usage

import { fetchApi } from 'rozod';
import { postMessagesUnarchive } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(postMessagesUnarchive, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`messageIds`	`number[]`

Response

Field	Type	Description
`failedMessages`	`object[]`	See below

failedMessages[] item fields:

Field	Type	Description
`messageId`	`number`
`errorMessage`	`string`

Errors

Status	Description
400	5: Too many ids in a batch request.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`getMessagesUnreadCount`

GET /v1/messages/unread/count

Gets unread messages for the authenticated user.

Usage

import { fetchApi } from 'rozod';
import { getMessagesUnreadCount } from 'rozod/lib/endpoints/privatemessagesv1';

const data = await fetchApi(getMessagesUnreadCount, undefined);

Response

Field	Type	Description
`count`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.