{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "notificationId": { "type": "string", "description": "The ID of the notification to mark as read." } }, "required": [ "PCID", "notificationId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "notificationId": { "type": "string", "description": "The ID of the notification to mark as seen." } }, "required": [ "PCID", "notificationId" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stats": { "type": "object", "description": "The stats value", "properties": { "int": { "type": "number", "description": "The number of points to allocate to INT (Intelligence) stat." }, "str": { "type": "number", "description": "The number of points to allocate to STR (Strength) stat." }, "con": { "type": "number", "description": "The number of points to allocate to CON (Constitution) stat." }, "per": { "type": "number", "description": "The number of points to allocate to PER (Perception) stat." } }, "required": [ "int", "str", "con", "per" ] } }, "required": [ "PCID" ]}
Block / unblock a user from sending you a PMParameters:
Parameter
Type
Required
Default
Description
uuid
string
Yes
—
The UUID of the user to block.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uuid": { "type": "string", "description": "The UUID of the user to block." } }, "required": [ "PCID", "uuid" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key of the gear to be purchased." } }, "required": [ "PCID", "key" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key of the mystery set to be purchased." } }, "required": [ "PCID", "key" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key of the quest to be purchased." } }, "required": [ "PCID", "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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The special item to buy. Must be one of the keys from \"content.special\", such as birthday, snowball, salt." } }, "required": [ "PCID", "key" ]}
The hour number (0-23) for the day to begin. If not supplied, it will default to 0.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dayStart": { "type": "number", "description": "The hour number (0-23) for the day to begin. If not supplied, it will default to 0." } }, "required": [ "PCID" ]}
Count of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "string", "description": "The type of item to purchase.", "enum": [ "pets", "mounts" ] }, "key": { "type": "string", "description": "The key for the mount/pet." }, "quantity": { "type": "integer", "description": "Count of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant." } }, "required": [ "PCID", "type", "key" ]}
Unlock item or set of items by purchaseParameters:
Parameter
Type
Required
Default
Description
path
string
Yes
—
Full path to unlock. See “content” API call for list of items
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "path": { "type": "string", "description": "Full path to unlock. See \"content\" API call for list of items" } }, "required": [ "PCID", "path" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enabled": { "type": "boolean", "description": "If the webhook should be enabled." }, "id": { "type": "string", "description": "The webhook's id." }, "label": { "type": "string", "description": "A label to remind you what this webhook does." }, "options": { "type": "object", "description": "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": { "type": "string", "description": "The webhook's type.", "enum": [ "taskActivity", "groupChatReceived", "userActivity", "questActivity" ] }, "url": { "type": "string", "description": "The webhook's URL." } }, "required": [ "PCID", "url" ]}
Load the messages of the selected Page - 10 Messages per Page
conversation
string
No
—
Loads only the messages of a conversation
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Load the messages of the selected Page - 10 Messages per Page" }, "conversation": { "type": "string", "description": "Loads only the messages of a conversation" } }, "required": [ "PCID" ]}
The user’s password if they use local authentication. Omit if they use social auth.
username
string
No
—
The new username
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "password": { "type": "string", "description": "The user's password if they use local authentication. Omit if they use social auth." }, "username": { "type": "string", "description": "The new username" } }, "required": [ "PCID" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Id (UUID) of the webhook to retrieve" }, "enabled": { "type": "boolean", "description": "If the webhook should be enabled." }, "label": { "type": "string", "description": "A label to remind you what this webhook does." }, "options": { "type": "object", "description": "The webhook's options. Will differ depending on type. The options are enumerated in the [add webhook examples](https://habitica.com/apidoc/#api-Webhook-UserAddWebhook)." }, "type": { "type": "string", "description": "The webhook's type.", "enum": [ "taskActivity", "groupChatReceived", "userActivity", "questActivity" ] }, "url": { "type": "string", "description": "The webhook's URL." } }, "required": [ "PCID", "id" ]}