The UUID of the group to which the challenge belongs.
name
string
Yes
—
The full name of the challenge.
official
boolean
No
—
Specifies whether the challenge is an official Habitica challenge.
prize
number
No
—
The prize or reward associated with the challenge.
shortName
string
Yes
—
A shortened name for the challenge, to be used as a tag.
summary
string
No
—
A short summary advertising the main purpose of the challenge; maximum 250 characters; if not supplied, challenge.name will be used.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "A detailed description of the challenge." }, "group": { "type": "string", "description": "The UUID of the group to which the challenge belongs." }, "name": { "type": "string", "description": "The full name of the challenge." }, "official": { "type": "boolean", "description": "Specifies whether the challenge is an official Habitica challenge." }, "prize": { "type": "number", "description": "The prize or reward associated with the challenge." }, "shortName": { "type": "string", "description": "A shortened name for the challenge, to be used as a tag." }, "summary": { "type": "string", "description": "A short summary advertising the main purpose of the challenge; maximum 250 characters; if not supplied, challenge.name will be used." } }, "required": [ "PCID", "group", "name", "shortName" ]}
The Challenge ID for the challenge to close with a winner.
winnerId
string
Yes
—
The User ID of the winning user.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "challengeId": { "type": "string", "description": "The Challenge ID for the challenge to close with a winner." }, "winnerId": { "type": "string", "description": "The User ID of the winning user." } }, "required": [ "PCID", "challengeId", "winnerId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the new group." }, "privacy": { "type": "string", "description": "Privacy of group (party MUST be private)", "enum": [ "private", "public" ] }, "type": { "type": "string", "description": "Type of group (guild or party)", "enum": [ "guild", "party" ] } }, "required": [ "PCID", "name", "privacy", "type" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
managerId
string
Yes
—
The UUID of the user.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "managerId": { "type": "string", "description": "The UUID of the user." } }, "required": [ "PCID", "groupId", "managerId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
previousMsg
string
No
—
The previous chat message’s UUID which will force a return of the full group chat.
message
string
No
—
The content of the chat message.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "previousMsg": { "type": "string", "description": "The previous chat message's UUID which will force a return of the full group chat." }, "message": { "type": "string", "description": "The content of the chat message." } }, "required": [ "PCID", "groupId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
chatId
string
Yes
—
The UUID of the chat message to clear flags from.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "chatId": { "type": "string", "description": "The UUID of the chat message to clear flags from." } }, "required": [ "PCID", "groupId", "chatId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted).
chatId
string
Yes
—
The chat message id.
comment
string
No
—
Explanation why the message was flagged.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)." }, "chatId": { "type": "string", "description": "The chat message id." }, "comment": { "type": "string", "description": "Explanation why the message was flagged." } }, "required": [ "PCID", "groupId", "chatId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
chatId
string
Yes
—
The UUID of the chat message to like.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "chatId": { "type": "string", "description": "The UUID of the chat message to like." } }, "required": [ "PCID", "groupId", "chatId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)" } }, "required": [ "PCID", "groupId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
emails
object[]
No
—
An array of objects, each representing one email address to invite.
uuids
string[]
No
—
An array of user IDs to invite.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "emails": { "type": "array", "items": { "type": "object" }, "description": "An array of objects, each representing one email address to invite." }, "uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of user IDs to invite." } }, "required": [ "PCID", "groupId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" } }, "required": [ "PCID", "groupId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
keep
string
No
—
Specify whether to remove or keep challenges when leaving the group.
keepChallenges
string
No
—
Specify whether to remain in challenges or leave challenges upon leaving the group.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "keep": { "type": "string", "description": "Specify whether to remove or keep challenges when leaving the group.", "enum": [ "remove-all", "keep-all" ] }, "keepChallenges": { "type": "string", "description": "Specify whether to remain in challenges or leave challenges upon leaving the group.", "enum": [ "remain-in-challenges", "leave-challenges" ] } }, "required": [ "PCID", "groupId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" } }, "required": [ "PCID", "groupId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
managerId
string
Yes
—
The UUID of the user.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "managerId": { "type": "string", "description": "The UUID of the user." } }, "required": [ "PCID", "groupId", "managerId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
memberId
string
Yes
—
The ID of the member to be removed from the group.
message
string
No
—
The message to send to the removed members.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "memberId": { "type": "string", "description": "The ID of the member to be removed from the group." }, "message": { "type": "string", "description": "The message to send to the removed members." } }, "required": [ "PCID", "groupId", "memberId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description of the group plan." }, "gems": { "type": "integer", "description": "The number of gems required for the plan." }, "interval": { "type": "string", "description": "The interval of the plan in cron syntax." }, "name": { "type": "string", "description": "The name of the group plan." } }, "required": [ "PCID" ]}
The previous chat message’s UUID which will force a return of the full group chat.
message
string
No
—
The content of the chat message.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "previousMsg": { "type": "string", "description": "The previous chat message's UUID which will force a return of the full group chat." }, "message": { "type": "string", "description": "The content of the chat message." } }, "required": [ "PCID" ]}
The UUID of the user to whom the message will be sent.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "message": { "type": "string", "description": "The private message to be sent." }, "toUserId": { "type": "string", "description": "The UUID of the user to whom the message will be sent." } }, "required": [ "PCID", "message", "toUserId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gemAmount": { "type": "integer", "description": "The number of gems to send" }, "message": { "type": "string", "description": "The message to the user" }, "toUserId": { "type": "string", "description": "The user to send the gift to" } }, "required": [ "PCID", "gemAmount", "toUserId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
chatId
string
Yes
—
The UUID of the chat message to delete.
previousMsg
string
No
—
The last message’s ID fetched by the client so that the whole chat will be returned only if new messages have been posted in the meantime.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "chatId": { "type": "string", "description": "The UUID of the chat message to delete." }, "previousMsg": { "type": "string", "description": "The last message's ID fetched by the client so that the whole chat will be returned only if new messages have been posted in the meantime." } }, "required": [ "PCID", "groupId", "chatId" ]}
The UUID of the challenge whose members are to be retrieved.
lastId
string
No
—
Query parameter to specify the last member returned in a previous request to this route and get the next batch of results.
limit
integer
No
—
BETA Query parameter to specify the number of results to return. Max is 60.
includeTasks
boolean
No
—
BETA Query parameter - If ‘true’ then include challenge tasks of each member.
includeAllPublicFields
boolean
No
—
If set to true then all public fields for members will be returned (similar to when making a request for a single member).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "challengeId": { "type": "string", "description": "The UUID of the challenge whose members are to be retrieved." }, "lastId": { "type": "string", "description": "Query parameter to specify the last member returned in a previous request to this route and get the next batch of results." }, "limit": { "type": "integer", "description": "BETA Query parameter to specify the number of results to return. Max is 60." }, "includeTasks": { "type": "boolean", "description": "BETA Query parameter - If 'true' then include challenge tasks of each member." }, "includeAllPublicFields": { "type": "boolean", "description": "If set to true then all public fields for members will be returned (similar to when making a request for a single member)." } }, "required": [ "PCID", "challengeId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "challengeId": { "type": "string", "description": "The ID of the challenge." }, "memberId": { "type": "string", "description": "The ID of the challenge member." } }, "required": [ "PCID", "challengeId", "memberId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)." } }, "required": [ "PCID", "groupId" ]}
This parameter can be used to specify the page number for the user challenges result (the initial page is number 0).
member
string
No
—
If set to true it limits results to challenges where the user is a member.
owned
string
No
—
If set to owned it limits results to challenges owned by the user. If set to not_owned it limits results to challenges not owned by the user.
search
string
No
—
Optional query parameter to filter results to challenges that include (even partially) the search query parameter in the name or description.
categories
string
No
—
Optional comma separated list of categories. If set it limits results to challenges that are part of the given categories.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "This parameter can be used to specify the page number for the user challenges result (the initial page is number 0)." }, "member": { "type": "string", "description": "If set to true it limits results to challenges where the user is a member." }, "owned": { "type": "string", "description": "If set to owned it limits results to challenges owned by the user. If set to not_owned it limits results to challenges not owned by the user." }, "search": { "type": "string", "description": "Optional query parameter to filter results to challenges that include (even partially) the search query parameter in the name or description." }, "categories": { "type": "string", "description": "Optional comma separated list of categories. If set it limits results to challenges that are part of the given categories." } }, "required": [ "PCID", "page" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" } }, "required": [ "PCID", "groupId" ]}
The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)" } }, "required": [ "PCID", "groupId" ]}
The group id (‘party’ for the user party is accepted)
lastId
string
No
—
Query parameter to specify the last invite returned in a previous request to this route and get the next batch of results.
limit
integer
No
—
BETA Query parameter to specify the number of results to return. Max is 60.
includeAllPublicFields
boolean
No
—
If set to true then all public fields for members will be returned (similar to when making a request for a single member).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party is accepted)" }, "lastId": { "type": "string", "description": "Query parameter to specify the last invite returned in a previous request to this route and get the next batch of results." }, "limit": { "type": "integer", "description": "BETA Query parameter to specify the number of results to return. Max is 60." }, "includeAllPublicFields": { "type": "boolean", "description": "If set to `true` then all public fields for members will be returned (similar to when making a request for a single member)." } }, "required": [ "PCID", "groupId" ]}
The group id (‘party’ for the user party is accepted)
lastId
string
No
—
Query parameter to specify the last member returned in a previous request to this route and get the next batch of results.
limit
integer
No
—
BETA Query parameter to specify the number of results to return. Max is 60.
includeTasks
boolean
No
—
BETA Query parameter - If ‘true’ then include challenge tasks of each member.
includeAllPublicFields
boolean
No
—
If set to true then all public fields for members will be returned (similar to when making a request for a single member).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group id ('party' for the user party is accepted)" }, "lastId": { "type": "string", "description": "Query parameter to specify the last member returned in a previous request to this route and get the next batch of results." }, "limit": { "type": "integer", "description": "BETA Query parameter to specify the number of results to return. Max is 60." }, "includeTasks": { "type": "boolean", "description": "BETA Query parameter - If 'true' then include challenge tasks of each member." }, "includeAllPublicFields": { "type": "boolean", "description": "If set to true then all public fields for members will be returned (similar to when making a request for a single member)." } }, "required": [ "PCID", "groupId" ]}
The ID of the member whose achievements are to be retrieved.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "memberId": { "type": "string", "description": "The ID of the member whose achievements are to be retrieved." } }, "required": [ "PCID", "memberId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "challengeId": { "type": "string", "description": "ID of the challenge to retrieve" }, "description": { "type": "string", "description": "The new challenge description." }, "name": { "type": "string", "description": "The new full name of the challenge." }, "summary": { "type": "string", "description": "The new challenge summary." } }, "required": [ "PCID", "challengeId" ]}
The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted)
name
string
No
—
The name of the new group.
privacy
string
No
—
Privacy of group (party MUST be private)
type
string
No
—
Type of group (guild or party)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)" }, "name": { "type": "string", "description": "The name of the new group." }, "privacy": { "type": "string", "description": "Privacy of group (party MUST be private)", "enum": [ "private", "public" ] }, "type": { "type": "string", "description": "Type of group (guild or party)", "enum": [ "guild", "party" ] } }, "required": [ "PCID", "groupId" ]}