/habitica-user | Type: Application | PCID required: Yes
Tools
habitica_user_create_cron
Run cronhabitica_user_create_notifications_by_notification_id_read
Mark Notification as Read Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId | string | Yes | — | The ID of the notification to mark as read. |
habitica_user_create_notifications_by_notification_id_see
Mark Notification as Seen Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId | string | Yes | — | The ID of the notification to mark as seen. |
habitica_user_create_notifications_read
Mark Notifications as Readhabitica_user_create_notifications_see
Mark Notifications as Seenhabitica_user_create_user_allocate
Allocate a single Stat Point Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
stat | string | Yes | — | The stat to increase (str, con, int, or per) |
habitica_user_create_user_allocate_bulk
Allocate multiple Stat Points Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
stats | object | No | — | The stats value |
habitica_user_create_user_allocate_now
Allocate all Stat Pointshabitica_user_create_user_block_by_uuid
Block / unblock a user from sending you a PM Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | The UUID of the user to block. |
habitica_user_create_user_buy_armoire
Buy Enchanted Armoirehabitica_user_create_user_buy_by_key
Buy gear, armoire or potion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The item to buy |
habitica_user_create_user_buy_gear_by_key
Buy a piece of gear Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key of the gear to be purchased. |
habitica_user_create_user_buy_health_potion
Buy a health potionhabitica_user_create_user_buy_mystery_set_by_key
Buy a Mystery Item set Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key of the mystery set to be purchased. |
habitica_user_create_user_buy_quest_by_key
Buy a quest with gold Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key of the quest to be purchased. |
habitica_user_create_user_buy_special_spell_by_key
Buy special item (card, avatar transformation) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The special item to buy. Must be one of the keys from “content.special”, such as birthday, snowball, salt. |
habitica_user_create_user_change_class
Change the class of the authenticated user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
class | string | Yes | — | The new class to change to |
habitica_user_create_user_class_cast_by_spell_id
Cast a skill (spell) on yourself or a target Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spellId | string | Yes | — | ID of the spell to cast |
targetId | string | No | — | User ID of the target (optional) |
habitica_user_create_user_custom_day_start
Set Custom Day Start time for user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dayStart | number | No | — | The hour number (0-23) for the day to begin. If not supplied, it will default to 0. |
habitica_user_create_user_disable_classes
Disable Classeshabitica_user_create_user_mark_pms_read
Mark Private Messages as readhabitica_user_create_user_open_mystery_item
Open the Mystery Item boxhabitica_user_create_user_purchase_by_type_by_key
Purchase Gem or Gem-purchasable item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | Type of item to purchase. Can be gems, eggs, hatchingPotions, premiumHatchingPotions, food, quests, gear, or pets. |
key | string | Yes | — | Item’s key (use “gem” for purchasing gems). |
quantity | integer | No | — | Count of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant. |
habitica_user_create_user_purchase_hourglass_by_type_by_key
Purchase Hourglass-purchasable item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | The type of item to purchase. |
key | string | Yes | — | The key for the mount/pet. |
quantity | integer | No | — | Count of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant. |
habitica_user_create_user_read_card_by_card_type
Read a card Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cardType | string | Yes | — | The of card to read (e.g. birthday, greeting, nye, thankyou, valentine). |
habitica_user_create_user_rebirth
Use Orb of Rebirth on userhabitica_user_create_user_reroll
Reroll user statshabitica_user_create_user_reset
Reset userhabitica_user_create_user_revive
Revive user from deathhabitica_user_create_user_sell_by_type_by_key
Sell a gold-sellable item owned by the user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | The type of item to sell |
key | string | Yes | — | The key of the item |
amount | number | No | — | The amount to sell |
habitica_user_create_user_sleep
Make the user start / stop sleeping (resting in the Inn)habitica_user_create_user_unequip_by_type
Unequip all items by type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | Type of the item to be unequipped |
habitica_user_create_user_unlock
Unlock item or set of items by purchase Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | Yes | — | Full path to unlock. See “content” API call for list of items |
habitica_user_create_user_webhook
Create user webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enabled | boolean | No | — | If the webhook should be enabled. |
id | string | No | — | The webhook’s id. |
label | string | No | — | A label to remind you what this webhook does. |
options | object | No | — | The webhook’s options. Will differ depending on type. Required for groupChatReceived type. If a webhook supports options, the default values are displayed in the examples below. |
type | string | No | — | The webhook’s type. |
url | string | Yes | — | The webhook’s URL. |
habitica_user_delete_messages
Delete all messageshabitica_user_delete_messages_by_id
Delete User Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | ID of the message to delete |
habitica_user_delete_user
Delete User Account [Danger] Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
feedback | string | No | — | The feedback value |
password | string | No | — | The password value |
habitica_user_delete_webhook_by_id
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Id (UUID) of the webhook to retrieve |
habitica_user_get_anonymized
Get anonymized user datahabitica_user_get_inbox_messages
Get Inbox Messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Load the messages of the selected Page - 10 Messages per Page |
conversation | string | No | — | Loads only the messages of a conversation |
habitica_user_get_purchase_history
Get user purchase historyhabitica_user_get_user
Get user informationhabitica_user_get_webhook
Get user webhookshabitica_user_update_user
Update the user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
achievements | object | No | — | The achievements value |
flags | object | No | — | The flags value |
preferences | object | No | — | The preferences value |
profile | object | No | — | The profile value |
stats | object | No | — | The stats value |
habitica_user_update_user_auth_update_email
Update email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
newEmail | string | Yes | — | The new email address |
password | string | No | — | The user password |
habitica_user_update_user_auth_update_password
Update password Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
confirmPassword | string | No | — | New password confirmation |
newPassword | string | No | — | The new password |
password | string | No | — | The old password |
habitica_user_update_user_auth_update_username
Update User’s Username Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
password | string | No | — | The user’s password if they use local authentication. Omit if they use social auth. |
username | string | Yes | — | The new username |
habitica_user_update_user_webhook_by_id
Edit a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Id (UUID) of the webhook to retrieve |
enabled | boolean | No | — | If the webhook should be enabled. |
label | string | No | — | A label to remind you what this webhook does. |
options | object | No | — | The webhook’s options. Will differ depending on type. The options are enumerated in the add webhook examples. |
type | string | No | — | The webhook’s type. |
url | string | No | — | The webhook’s URL. |

