Run a UPI creator support page from chat: supporters, goals, page, share assets. No money moves.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add a UPI ID for supporters to pay into. Kulhad cannot check that an address is real or that it belongs to the creator, so tell them to send one rupee to it themselves and confirm it arrived before sharing the page. Duplicates are not checked. The free plan keeps one ID active at a time.
The UPI address, as in priya@okhdfc.
What to call it, such as Personal or Shop.
Quote this one first.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Add a UPI ID for supporters to pay into. Kulhad cannot check that an address is real or that it belongs to the creator, so tell them to send one rupee to it themselves and confirm it arrived before sharing the page. Duplicates are not checked. The free plan keeps one ID active at a time.
| Argument | Type | Description |
|---|---|---|
| vpa* | string | The UPI address, as in priya@okhdfc. |
| label | string | What to call it, such as Personal or Shop. |
| makeDefault | boolean | Quote this one first. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vpa"
],
"properties": {
"vpa": {
"type": "string",
"description": "The UPI address, as in priya@okhdfc."
},
"label": {
"type": "string",
"maxLength": 40,
"description": "What to call it, such as Personal or Shop."
},
"makeDefault": {
"type": "boolean",
"default": false,
"description": "Quote this one first."
}
}
}Approve one supporter after the creator has found the payment in their own bank app. This cannot be undone. The supporter's name and amount then show on the creator's page and stream overlays and count toward totals and the active goal; if that fills the goal, the goal is marked complete and taken off the page. With hidden set, the message and any voice recording stay private while the name and amount still show. A thank-you reply (up to 280 characters, word-filtered) can be set at the same time and replaces any existing reply. Nothing is sent to the supporter. Only the creator can know whether the money arrived, so never approve without being asked to for that specific supporter.
| Argument | Type | Description |
|---|---|---|
| id* | integer | |
| reply | string | A thank-you shown beside them on the page, up to 280 characters. Replaces any existing reply. Refused if the word filter flags it. |
| hidden | boolean | Keep the message and any voice recording private. The name and amount still show on the page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"reply": {
"type": "string",
"description": "A thank-you shown beside them on the page, up to 280 characters. Replaces any existing reply. Refused if the word filter flags it."
},
"hidden": {
"type": "boolean",
"default": false,
"description": "Keep the message and any voice recording private. The name and amount still show on the page."
}
}
}Approve up to 100 waiting supporters at once after the creator has checked their bank. Part of Premium. This cannot be undone. Ids that are not waiting (already settled, not yet marked as sent, missing, or not this creator's) are skipped and counted. Same effects as approve_support; no reply is set.
| Argument | Type | Description |
|---|---|---|
| ids* | array | |
| hidden | boolean | Keep each message and voice recording private. Names and amounts still show on the page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"maxItems": 100,
"minItems": 1
},
"hidden": {
"type": "boolean",
"default": false,
"description": "Keep each message and voice recording private. Names and amounts still show on the page."
}
}
}Reject up to 100 waiting supporters at once. Part of Premium. This cannot be undone and any voice recordings are deleted immediately, so confirm the list with the creator first. Ids that are not waiting are skipped and counted.
| Argument | Type | Description |
|---|---|---|
| ids* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"maxItems": 100,
"minItems": 1
}
}
}Check whether a Kulhad page name is free. A page name is the last part of the address, as in kulhad.co/priya. Use this before suggesting a name to somebody setting up a page.
| Argument | Type | Description |
|---|---|---|
| username* | string | The page name to check, without the address around it. For example: priya |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"username"
],
"properties": {
"username": {
"type": "string",
"description": "The page name to check, without the address around it. For example: priya"
}
}
}Create a goal with a title and a target in whole rupees. Unless active is false, it becomes the goal shown on the page and any other goal is put away, not deleted (set_active_goal brings one back). The free plan refuses while another goal is running, even with active false. Impact tiers are Premium. A goal that is neither active nor complete has no page of its own.
| Argument | Type | Description |
|---|---|---|
| title* | string | |
| active | boolean | Show it on the page straight away. |
| impact | array | What each amount pays for, shown on the goal. Premium. |
| deadline | any | As YYYY-MM-DD. Null clears it. A goal does not stop at its deadline. |
| description | string | |
| targetAmount* | integer | In whole rupees. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"title",
"targetAmount"
],
"properties": {
"title": {
"type": "string",
"maxLength": 60
},
"active": {
"type": "boolean",
"default": true,
"description": "Show it on the page straight away."
},
"impact": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 40
},
"amount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
}
},
"maxItems": 3,
"description": "What each amount pays for, shown on the goal. Premium."
},
"deadline": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "As YYYY-MM-DD. Null clears it. A goal does not stop at its deadline."
},
"description": {
"type": "string",
"maxLength": 280
},
"targetAmount": {
"type": "integer",
"maximum": 10000000,
"minimum": 1,
"description": "In whole rupees."
}
}
}Delete a goal that has no approved support. This cannot be undone, and its cover image is deleted with it. Pending or rejected supports pinned to it lose the link. A goal with approved support stays in the history and can only be turned off.
| Argument | Type | Description |
|---|---|---|
| id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Remove one progress note from a goal by its position in the list, counting from zero with the newest first. This cannot be undone.
| Argument | Type | Description |
|---|---|---|
| index* | integer | Zero is the newest note. |
| goalId* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"goalId",
"index"
],
"properties": {
"index": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero is the newest note."
},
"goalId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Daily page views, approved supports and amounts for up to the last ninety days, thirty by default, with the rate at which visitors go on to support. Part of Premium. Comes from the nightly rollup, so today is not included and only days with activity are returned.
| Argument | Type | Description |
|---|---|---|
| days | integer | How many days back. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"default": 30,
"maximum": 90,
"minimum": 1,
"description": "How many days back."
}
}
}Read whether a custom domain is connected to the page, and what DNS record it needs. Part of Premium.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}The headline numbers from the creator dashboard: what came in this month against last, the all-time total, how many approved supports there have been, and how many are waiting to be approved.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get the HTML to put a support button, the pay card, or a live goal bar on the creator own website or blog. Returns the snippets to paste, not a rendered preview.
| Argument | Type | Description |
|---|---|---|
| text | string | The words on the button. |
| position | string | Which bottom corner the floating button sits in. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"text": {
"type": "string",
"default": "Support me",
"maxLength": 40,
"description": "The words on the button."
},
"position": {
"enum": [
"right",
"left"
],
"type": "string",
"default": "right",
"description": "Which bottom corner the floating button sits in."
}
}
}Read one goal in full, including its impact tiers and its progress notes.
| Argument | Type | Description |
|---|---|---|
| id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Read the page details for the signed-in creator: name, page address, bio, links, language, plan, and any custom domain recorded on the account with its status (pending, active or disabled).
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Read the current appearance and behaviour settings for the page: theme, banner, suggested amounts, what is shown publicly, and the thank-you note.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Read which plan the account is on, when Premium runs to, whether it is set to end, and the past charges with links to their invoices. Read-only: nothing here starts, changes or cancels a subscription.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get the page address, a QR code that opens the page (and a UPI payment QR for the counter when the counter QR is switched on), share images for stories and posts, and the printable sheets. Everything comes back as a link to open or download, not as an image.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get the three overlay addresses to add to OBS or any streaming software as a browser source: a goal bar, a wall of recent supporters, and an alert that appears when someone gives. Includes the size each source should be and when alerts currently fire.
| Argument | Type | Description |
|---|---|---|
| language | string | Which language the overlays speak. "page" follows the page language and keeps following it if that changes later. |
| wallRows | integer | How many supporters the wall shows at once. |
| alertSeconds | integer | How long each alert stays on screen. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"language": {
"enum": [
"page",
"en",
"hi",
"hi-Latn",
"mr",
"ta",
"te",
"ml"
],
"type": "string",
"default": "page",
"description": "Which language the overlays speak. \"page\" follows the page language and keeps following it if that changes later."
},
"wallRows": {
"type": "integer",
"default": 5,
"maximum": 20,
"minimum": 1,
"description": "How many supporters the wall shows at once."
},
"alertSeconds": {
"type": "integer",
"default": 8,
"maximum": 30,
"minimum": 3,
"description": "How long each alert stays on screen."
}
}
}Read everything the creator can see about one supporter, by its id.
| Argument | Type | Description |
|---|---|---|
| id* | integer | From list_supports or list_pending_supports. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "From list_supports or list_pending_supports."
}
}
}Break approved support down by where it came from: the page itself, an embedded button, a QR code, the printed counter card, or a link tagged for WhatsApp, Instagram, YouTube or a standee. Use this to answer which channel is actually working.
| Argument | Type | Description |
|---|---|---|
| to | string | Only up to this date, as YYYY-MM-DD. |
| from | string | Only from this date onward, as YYYY-MM-DD. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"to": {
"type": "string",
"description": "Only up to this date, as YYYY-MM-DD."
},
"from": {
"type": "string",
"description": "Only from this date onward, as YYYY-MM-DD."
}
}
}Kulhad Wrapped for a year: how many people supported, the total, page views, the busiest month, and the largest single support. Free on every plan.
| Argument | Type | Description |
|---|---|---|
| year | integer | Defaults to the current year. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"year": {
"type": "integer",
"maximum": 2100,
"minimum": 2024,
"description": "Defaults to the current year."
}
}
}List every goal on the page, the active one first, with how much each has raised against its target.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List the supporters who have marked a payment as sent and are waiting for the creator to approve them. Kulhad cannot see a bank account, so this is what people say they sent, not what has been received. The creator checks their own bank app for the amount and the four-character code, then approves.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many to return. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1,
"description": "How many to return."
}
}
}List supporters, newest first, optionally narrowed by status or by date. Use this for history and for questions about a particular period; use list_pending_supports for the approval queue.
| Argument | Type | Description |
|---|---|---|
| to | string | Only up to this date, as YYYY-MM-DD. |
| from | string | Only from this date onward, as YYYY-MM-DD. |
| page | integer | |
| limit | integer | |
| status | string | claimed means waiting for the creator to approve. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"to": {
"type": "string",
"description": "Only up to this date, as YYYY-MM-DD."
},
"from": {
"type": "string",
"description": "Only from this date onward, as YYYY-MM-DD."
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": 1
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1
},
"status": {
"enum": [
"all",
"claimed",
"approved",
"approved_hidden",
"rejected"
],
"type": "string",
"default": "all",
"description": "claimed means waiting for the creator to approve."
}
}
}List the UPI IDs on the account, which are the addresses supporters pay into. The free plan keeps one of them active at a time.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Add a short note, up to 280 characters, under a goal saying what the money did. Notes are kept newest first, at most 20 per goal, and show on the goal's page while the goal is active or complete. Free on every plan. Nobody is notified.
| Argument | Type | Description |
|---|---|---|
| body* | string | What happened. Shown publicly under the goal. |
| goalId* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"goalId",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 280,
"description": "What happened. Shown publicly under the goal."
},
"goalId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Reject one supporter when the creator has checked their bank and the payment is not there. This cannot be undone. Any voice recording is deleted immediately; the record itself is cleared a week later. Nothing shows on the page and nothing is sent to the supporter.
| Argument | Type | Description |
|---|---|---|
| id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Disconnect the custom domain, so the page is served from its kulhad.co address again. Anything printed with the old domain on it stops working, so confirm with the creator first.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Remove a UPI ID from the account. The last one, and the only active one, cannot be removed. This cannot be undone, and past supports lose the link to it; switching it off instead keeps it.
| Argument | Type | Description |
|---|---|---|
| id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Write or replace the thank-you beside one supporter, up to 280 characters; links and flagged words are refused. It shows on the creator's page once the supporter is approved, and on the supporter's own receipt link in any case. Replaces the previous reply with no history and cannot be blanked. Does not approve anyone and sends nothing.
| Argument | Type | Description |
|---|---|---|
| id* | integer | |
| reply* | string | Shown publicly beside them on the page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"reply"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"reply": {
"type": "string",
"maxLength": 280,
"description": "Shown publicly beside them on the page."
}
}
}Fire a test alert so the creator can see where it lands in OBS while setting up. It is not a real support: nothing is recorded, no goal moves and nobody is thanked. The overlay picks it up within about five seconds and it disappears after six.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Make one goal the one shown on the page, or turn the current one off. The page shows a single goal at a time, so choosing one puts the others away without deleting anything. Reversible.
| Argument | Type | Description |
|---|---|---|
| id* | integer | |
| active | boolean | False turns this goal off and shows none. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"active": {
"type": "boolean",
"default": true,
"description": "False turns this goal off and shows none."
}
}
}Record the domain the creator wants in front of their page and return the DNS record to add. Part of Premium. Replaces any domain already recorded, including a working one, which then stops serving until verify_custom_domain passes again, so confirm with the creator if a domain is already active. This does not touch DNS or make the domain work: the creator adds the record at their registrar, then verify_custom_domain checks it.
| Argument | Type | Description |
|---|---|---|
| domain* | string | For example: priya.in or support.priya.in |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "For example: priya.in or support.priya.in"
}
}
}Make one active UPI ID the one supporters are shown first. The others stay on the account. This does not switch an ID on: an inactive ID made default is never quoted.
| Argument | Type | Description |
|---|---|---|
| id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}Replace the list of ready-made thank-you replies the creator picks from when approving a supporter. Part of Premium. At most 7, each up to 280 characters; blank replies and any containing a link or a flagged word are dropped and counted. Passing an empty list removes all of them.
| Argument | Type | Description |
|---|---|---|
| replies* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"replies"
],
"properties": {
"replies": {
"type": "array",
"items": {
"type": "string",
"maxLength": 280
},
"maxItems": 7
}
}
}When on, active UPI IDs take turns being quoted so support spreads across them instead of landing in one account. Part of Premium.
| Argument | Type | Description |
|---|---|---|
| enabled* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
}
}Get a link that opens Kulhad sign-up with a page name already filled in. Hand it to the person setting up the page; they finish it themselves in a browser. This does not create an account and cannot. It marks the name as taken for check_username_available for fifteen minutes; it does not stop anyone signing up with that name directly. Nothing is sent.
| Argument | Type | Description |
|---|---|---|
| username* | string | The page name to reserve and prefill. For example: priya |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"username"
],
"properties": {
"username": {
"type": "string",
"description": "The page name to reserve and prefill. For example: priya"
}
}
}Change a goal's title, target, description, deadline or impact tiers. Only the fields you pass change, and each replaces the old value; impact replaces the whole list. Renaming changes the goal's web address, and the old address stops working with no redirect. Changing the target does not re-check whether the goal is complete.
| Argument | Type | Description |
|---|---|---|
| id* | integer | |
| title | string | |
| impact | array | What each amount pays for, shown on the goal. Premium. |
| deadline | any | As YYYY-MM-DD. Null clears it. A goal does not stop at its deadline. |
| description | string | |
| targetAmount | integer | In whole rupees. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"title": {
"type": "string",
"maxLength": 60
},
"impact": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 40
},
"amount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
}
},
"maxItems": 3,
"description": "What each amount pays for, shown on the goal. Premium."
},
"deadline": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "As YYYY-MM-DD. Null clears it. A goal does not stop at its deadline."
},
"description": {
"type": "string",
"maxLength": 280
},
"targetAmount": {
"type": "integer",
"maximum": 10000000,
"minimum": 1,
"description": "In whole rupees."
}
}
}Change the page theme and the announcement banner across the top of it. Page themes, a custom theme colour (shown only when the theme is "custom"), your own banner colour, hiding the Kulhad badge, and a Google Analytics measurement ID are Premium. The measurement ID is stored as a page setting; Kulhad itself does not contact Google. Each value passed replaces the current one. Writes to the creator's own Kulhad account only.
| Argument | Type | Description |
|---|---|---|
| theme | string | Premium. |
| themeColor | string | A six-digit colour code starting with a hash, for the custom theme. An empty string clears it. |
| badgeHidden | boolean | Hide the "Powered by kulhad" badge. Premium. |
| occasionText | string | The banner text. Empty string clears it. |
| occasionColor | string | The banner colour. "own" uses occasionColorHex and is Premium. |
| occasionUntil | any | The last day the banner shows, as YYYY-MM-DD. It shows through the whole of that day, India time. Null or an empty string removes the end date. |
| gaMeasurementId | string | A Google Analytics ID like G-XXXXXXXXXX. Premium. Empty string clears it. |
Change what the page does: whether new supporters go up without approval, whether people may give without a name, whether the supporter count and total show, the three suggested amounts and their labels, the headline on the pay card, the note supporters see after paying, when stream alerts fire, and whether voice messages are allowed (Premium). Passing amounts replaces all three. A label or headline that fails the word filter is blanked. Affects future supports only. Writes to the creator's own Kulhad account only.
| Argument | Type | Description |
|---|---|---|
| amounts | array | The three suggested amounts and what each is for. |
| amountStyle | string | Which set of suggested amounts the page offers. |
| autoPublish | boolean | Put a supporter on the page as soon as they mark a payment as sent, without waiting for approval. |
| cardHeadline | string | The line above the name on share cards. |
| thankYouNote | string | Shown to a supporter after they pay. |
| streamAlertOn | string | When the stream alert overlay fires. "approved" waits until you have looked at a support, which is how every other surface behaves. "claimed" fires as soon as someone marks a payment as sent, which is faster but puts a message nobody has read yet on the stream. Only change this to "claimed" if the creator has said they want that. |
Change the creator's name, bio, page address, kind of page (person or organisation), page language, dashboard language, and the links on the page. Only the fields you pass change. Links replace the whole list, so pass every link that should stay. The bio keeps bold, italic, links and line breaks and is cut at 280 characters. Changing the page address stops the old kulhad.co address working at once, with no redirect: printed QR codes, embeds and OBS overlay links break, and the old name is free for anyone to take. Not allowed while a custom domain is active. Writes to the creator's own Kulhad account only.
| Argument | Type | Description |
|---|---|---|
| bio | string | A short introduction. Bold, italic, links and line breaks are kept, everything else is stripped, and it is cut at 280 characters. |
| kind | string | |
| name | string | The name shown on the page. |
| socials | array | Replaces the whole list. Pass an empty array to remove every link. |
| username | string | The page address, as in kulhad.co/priya. The old address stops working immediately with no redirect, and the old name becomes free. Cannot be changed while a custom domain is active. |
| uiLanguage | string | The creator dashboard language. |
| pageLanguage |
Set the title (up to 60 characters) and description (up to 160) in the page's HTML head, which search engines and link previews read. Part of Premium. A blank value goes back to the text Kulhad generates. This does not set an image and does not contact any search engine; it only changes what the page serves.
| Argument | Type | Description |
|---|---|---|
| seoTitle | string | |
| seoDescription | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"seoTitle": {
"type": "string",
"maxLength": 60
},
"seoDescription": {
"type": "string",
"maxLength": 160
}
}
}Change the address or label of a UPI ID, switch it on or off, or mark the one-rupee test done. Changing the address clears the test, and from then on the new address is what supporters are quoted and what past supports display. At least one ID has to stay active. Switching off the default leaves the lowest active ID quoted.
| Argument | Type | Description |
|---|---|---|
| id* | integer | |
| vpa | string | |
| label | string | |
| active | boolean | |
| testDone | boolean | Only set this true when the creator says they saw the rupee arrive. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"vpa": {
"type": "string"
},
"label": {
"type": "string",
"maxLength": 40
},
"active": {
"type": "boolean"
},
"testDone": {
"type": "boolean",
"description": "Only set this true when the creator says they saw the rupee arrive."
}
}
}Look the domain up in public DNS and, if it points at Kulhad, switch the page to it; kulhad.co/<name> then redirects there. Part of Premium. Clears the same domain from any other account's unverified claim. Fails until the record has propagated, which is normal for the first few minutes.
| Argument | Type | Description |
|---|---|---|
| domain* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string"
}
}
}| occasionColorHex | string | The banner colour when occasionColor is "own", as a six-digit code starting with a hash. Empty string clears it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"theme": {
"enum": [
"clay",
"marigold",
"ink",
"diwali",
"holi",
"custom"
],
"type": "string",
"description": "Premium."
},
"themeColor": {
"type": "string",
"description": "A six-digit colour code starting with a hash, for the custom theme. An empty string clears it."
},
"badgeHidden": {
"type": "boolean",
"description": "Hide the \"Powered by kulhad\" badge. Premium."
},
"occasionText": {
"type": "string",
"maxLength": 80,
"description": "The banner text. Empty string clears it."
},
"occasionColor": {
"enum": [
"clay",
"marigold",
"ink",
"neel",
"mor",
"gulaal",
"own"
],
"type": "string",
"description": "The banner colour. \"own\" uses occasionColorHex and is Premium."
},
"occasionUntil": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The last day the banner shows, as YYYY-MM-DD. It shows through the whole of that day, India time. Null or an empty string removes the end date."
},
"gaMeasurementId": {
"type": "string",
"description": "A Google Analytics ID like G-XXXXXXXXXX. Premium. Empty string clears it."
},
"occasionColorHex": {
"type": "string",
"pattern": "^(#[0-9a-fA-F]{6})?$",
"description": "The banner colour when occasionColor is \"own\", as a six-digit code starting with a hash. Empty string clears it."
}
}
}| allowAnonymous | boolean | Let people give without leaving a name. |
| showTotalRaised | boolean | Show the total amount received. |
| counterQrEnabled | boolean | Offer the printable counter QR, which carries no amount and no message. |
| showSupporterCount | boolean | Show how many people have given. |
| voiceBlessingsEnabled | boolean | Let supporters record a short voice message. Premium. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"amounts": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 24
},
"amount": {
"type": "integer",
"maximum": 100000,
"minimum": 1
}
}
},
"maxItems": 3,
"minItems": 3,
"description": "The three suggested amounts and what each is for."
},
"amountStyle": {
"enum": [
"chai",
"shagun",
"nashta",
"dakshina",
"patron"
],
"type": "string",
"description": "Which set of suggested amounts the page offers."
},
"autoPublish": {
"type": "boolean",
"description": "Put a supporter on the page as soon as they mark a payment as sent, without waiting for approval."
},
"cardHeadline": {
"type": "string",
"maxLength": 40,
"description": "The line above the name on share cards."
},
"thankYouNote": {
"type": "string",
"maxLength": 280,
"description": "Shown to a supporter after they pay."
},
"streamAlertOn": {
"enum": [
"approved",
"claimed"
],
"type": "string",
"description": "When the stream alert overlay fires. \"approved\" waits until you have looked at a support, which is how every other surface behaves. \"claimed\" fires as soon as someone marks a payment as sent, which is faster but puts a message nobody has read yet on the stream. Only change this to \"claimed\" if the creator has said they want that."
},
"allowAnonymous": {
"type": "boolean",
"description": "Let people give without leaving a name."
},
"showTotalRaised": {
"type": "boolean",
"description": "Show the total amount received."
},
"counterQrEnabled": {
"type": "boolean",
"description": "Offer the printable counter QR, which carries no amount and no message."
},
"showSupporterCount": {
"type": "boolean",
"description": "Show how many people have given."
},
"voiceBlessingsEnabled": {
"type": "boolean",
"description": "Let supporters record a short voice message. Premium."
}
}
}| string |
| The language the public page is written in. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"bio": {
"type": "string",
"description": "A short introduction. Bold, italic, links and line breaks are kept, everything else is stripped, and it is cut at 280 characters."
},
"kind": {
"enum": [
"person",
"organization"
],
"type": "string"
},
"name": {
"type": "string",
"maxLength": 60,
"description": "The name shown on the page."
},
"socials": {
"type": "array",
"items": {
"type": "object",
"required": [
"platform",
"url"
],
"properties": {
"url": {
"type": "string"
},
"platform": {
"enum": [
"instagram",
"youtube",
"facebook",
"x",
"threads",
"whatsapp",
"telegram",
"linkedin",
"pinterest",
"snapchat",
"spotify",
"discord",
"twitch",
"reddit",
"github",
"website",
"other"
],
"type": "string"
}
}
},
"maxItems": 6,
"description": "Replaces the whole list. Pass an empty array to remove every link."
},
"username": {
"type": "string",
"description": "The page address, as in kulhad.co/priya. The old address stops working immediately with no redirect, and the old name becomes free. Cannot be changed while a custom domain is active."
},
"uiLanguage": {
"enum": [
"en",
"hi",
"hi-Latn",
"mr",
"ta",
"te",
"ml"
],
"type": "string",
"description": "The creator dashboard language."
},
"pageLanguage": {
"enum": [
"en",
"hi",
"hi-Latn",
"mr",
"ta",
"te",
"ml"
],
"type": "string",
"description": "The language the public page is written in."
}
}
}