Account Information v1

Reference for the Account Information v1 endpoints on Roblox.

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

Endpoints

Method	Path	Name
GET	/v1/birthdate	getBirthdate
GET	/v1/description	getDescription
POST	/v1/description	postDescription
POST	/v1/email/verify	postEmailVerify
GET	/v1/gender	getGender
POST	/v1/gender	postGender
GET	/v1/metadata	getMetadata
GET	/v1/phone	getPhone
POST	/v1/phone	postPhone
POST	/v1/phone/delete	postPhoneDelete
POST	/v1/phone/resend	postPhoneResend
POST	/v1/phone/verify	postPhoneVerify
GET	/v1/promotion-channels	getPromotionChannels
POST	/v1/promotion-channels	postPromotionChannels
GET	/v1/users/:userId/promotion-channels	getUsersUseridPromotionChannels
GET	/v1/users/:userId/roblox-badges	getUsersUseridRobloxBadges

getBirthdate

GET /v1/birthdate

Get the user’s birthdate

Usage

import { fetchApi } from 'rozod';
import { getBirthdate } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getBirthdate, undefined);

Response

Field	Type	Description
birthMonth	number
birthDay	number
birthYear	number

Errors

Status	Description
400	1: User not found.
401	0: Authorization has been denied for this request.

---

getDescription

GET /v1/description

Get the user’s description

Usage

import { fetchApi } from 'rozod';
import { getDescription } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getDescription, undefined);

Response

Field	Type	Description
description	string

Errors

Status	Description
400	1: User not found.
401	0: Authorization has been denied for this request.

---

postDescription

POST /v1/description

Update the user’s description

Usage

import { fetchApi } from 'rozod';
import { postDescription } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
description	string

Response

Field	Type	Description
description	string

Errors

Status	Description
400	1: User not found.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
500	0: An unknown error occured.
503	3: This feature is currently disabled. Please try again later.

---

postEmailVerify

POST /v1/email/verify

Verify the user’s email address from token

Usage

import { fetchApi } from 'rozod';
import { postEmailVerify } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
ticket	string

Response

Field	Type	Description
verifiedUserHatAssetId	number

Errors

Status	Description
403	0: Token Validation Failed

---

getGender

GET /v1/gender

Get the user’s gender

Usage

import { fetchApi } from 'rozod';
import { getGender } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getGender, undefined);

Response

Field	Type	Description
gender	number

Errors

Status	Description
400	1: User not found.
401	0: Authorization has been denied for this request.

---

postGender

POST /v1/gender

Update the user’s gender

Usage

import { fetchApi } from 'rozod';
import { postGender } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
gender	string

Response

Type: unknown

Errors

Status	Description
400	1: User not found. 6: The gender provided is invalid.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
500	0: An unknown error occured.

---

getMetadata

GET /v1/metadata

Get the metadata

Usage

import { fetchApi } from 'rozod';
import { getMetadata } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getMetadata, undefined);

Response

Field	Type	Description
isAllowedNotificationsEndpointDisabled	boolean
isAccountSettingsPolicyEnabled	boolean
isPhoneNumberEnabled	boolean
MaxUserDescriptionLength	number
isUserDescriptionEnabled	boolean
isUserBlockEndpointsUpdated	boolean
shouldUsePersonaForIdVerification	boolean
shouldDisplaySessionManagement	boolean
isPasswordRequiredForAgingDown	boolean

---

getPhone

GET /v1/phone

Get Verified Phone Number

Usage

import { fetchApi } from 'rozod';
import { getPhone } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getPhone, undefined);

Response

Field	Type	Description
countryCode	string
prefix	string
phone	string
isVerified	boolean
verificationCodeLength	number
canBypassPasswordForPhoneUpdate	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.
500	0: An unknown error occured.

---

postPhone

POST /v1/phone

Set Phone Number

Usage

import { fetchApi } from 'rozod';
import { postPhone } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
countryCode	string
prefix	string
phone	string
password	string
verificationChannel	string

Response

Field	Type	Description
verificationChannel	string
data	string

Errors

Status	Description
400	2: Invalid Phone Number 3: Phone Number Already Associated 8: Invalid Phone Number Type
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 5: Incorrect Password 10:
429	6: Flooded
500	0: An unknown error occured.
503	1: This feature is currently disabled. Please try again later.

---

postPhoneDelete

POST /v1/phone/delete

Delete Phone

Usage

import { fetchApi } from 'rozod';
import { postPhoneDelete } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
countryCode	string
prefix	string
phone	string
password	string
verificationChannel	string

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 5: Incorrect Password
429	6: Flooded
500	0: An unknown error occured.
503	1: This feature is currently disabled. Please try again later.

---

postPhoneResend

POST /v1/phone/resend

Resend Phone code

Usage

import { fetchApi } from 'rozod';
import { postPhoneResend } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Type: unknown

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
429	6: Flooded
500	0: An unknown error occured.
503	1: This feature is currently disabled. Please try again later.

---

postPhoneVerify

POST /v1/phone/verify

Verify Phone

Usage

import { fetchApi } from 'rozod';
import { postPhoneVerify } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
code	string

Response

Type: unknown

Errors

Status	Description
400	2: Invalid Phone Number 3: Phone Number Already Associated 7: Invalid Code
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
429	6: Flooded
500	0: An unknown error occured.
503	1: This feature is currently disabled. Please try again later.

---

getPromotionChannels

GET /v1/promotion-channels

Get the user’s promotion channels

Usage

import { fetchApi } from 'rozod';
import { getPromotionChannels } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getPromotionChannels, {
  alwaysReturnUrls: /* boolean? */,
  filterLink: /* boolean? */,
  onlyShortenTwitter: /* boolean? = true */
});

Parameters

Name	Type	Required	Description
alwaysReturnUrls	boolean?	No	Whether all promotion channel links should be returned as full URLs.
filterLink	boolean?	No	Whether all promotion channel links should be filtered.
onlyShortenTwitter	boolean? = true	No	Whether all promotion channels links except for Twitter should be returned as full URLs. If false, all promotion channels will be shortened.

Response

Field	Type	Description
promotionChannelsVisibilityPrivacy	string
facebook	string
twitter	string
youtube	string
twitch	string

Errors

Status	Description
400	1: User not found.
401	0: Authorization has been denied for this request.

---

postPromotionChannels

POST /v1/promotion-channels

Update the user’s promotion channels

Usage

import { fetchApi } from 'rozod';
import { postPromotionChannels } from 'rozod/endpoints/accountinformationv1';

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

Request Body

Field	Type	Description
facebook	string
twitter	string
youtube	string
twitch	string
promotionChannelsVisibilityPrivacy	string

Response

Type: unknown

Errors

Status	Description
400	2: The request was empty. 11: The Facebook profile url is invalid. 12: The Twitter handle is invalid. 13: The YouTube url is invalid. 14: The Twitch profile url is invalid.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 4: Only users who are over twelve years of age may edit social network channels.

---

getUsersUseridPromotionChannels

GET /v1/users/:userId/promotion-channels

Get promotion channels for a given user ID

Usage

import { fetchApi } from 'rozod';
import { getUsersUseridPromotionChannels } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getUsersUseridPromotionChannels, {
  userId: /* integer */,
  alwaysReturnUrls: /* boolean? */,
  filterLink: /* boolean? */
});

Parameters

Name	Type	Required	Description
userId	integer	Yes	The ID of the user to fetch the promotion channels for.
alwaysReturnUrls	boolean?	No	Whether all promotion channel links should be returned as full URLs.
filterLink	boolean?	No	Whether all promotion channel links should be filtered.

Response

Field	Type	Description
facebook	string
twitter	string
youtube	string
twitch	string

Errors

Status	Description
400	1: User not found.

---

getUsersUseridRobloxBadges

GET /v1/users/:userId/roblox-badges

Returns a list of Roblox badges belonging to a user.

Usage

import { fetchApi } from 'rozod';
import { getUsersUseridRobloxBadges } from 'rozod/endpoints/accountinformationv1';

const data = await fetchApi(getUsersUseridRobloxBadges, {
  userId: /* integer */
});

Parameters

Name	Type	Required	Description
userId	integer	Yes

Response

Array of objects:

Field	Type	Description
id	number
name	string
description	string
imageUrl	string

---