Overview

This node operation allows users to equip or unequip an item for a user in the Habitica application. It supports different types of items such as mounts, pets, costumes, and gear. This operation is useful for automating the management of a user's inventory and appearance in Habitica, for example, equipping a new mount or changing a costume programmatically.

Use Case Examples

1. Equip a mount by specifying the item type as 'Mount' and providing the item key.
2. Unequip a pet by selecting the item type 'Pet' and the corresponding item key.

Properties

Name	Meaning
Type	Type of the item to equip or unequip, such as mount, pet, costume, or gear.
Key	Key of the item to equip or unequip, used to identify the specific item.
Request Options	Additional request options such as batching, SSL certificate handling, proxy settings, and timeout configuration.

Output

JSON

• itemType - The type of the item equipped or unequipped (mount, pet, costume, or gear).
• itemKey - The key identifier of the item equipped or unequipped.
• status - The result status of the equip or unequip operation, indicating success or failure.

Dependencies

• Habitica API, requiring an API key credential for authentication.

Troubleshooting

• Ensure the item key provided is valid and corresponds to an existing item in the user's inventory.
• Verify that the API credentials are correctly configured and have the necessary permissions to modify user items.
• Check network settings if using a proxy or if SSL certificate validation is disabled, as these can affect request success.
• Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Links

• Habitica API Documentation - Equip or Unequip an Item - Official API documentation for equipping or unequipping items in Habitica.