platforms.grantManage
Let a platform manage this shop. Shop owner only, on a hosted page.
| Who | Hosted page only (a person does it in the browser) |
| REST | POST /v1/platforms/grant |
| MCP tool | Not an MCP tool |
| Writes | yes, send an Idempotency-Key |
| Area | Developers and platforms |
When to use it
Never call it. The shop owner allows a platform on the hosted page.
What to tell the owner
Open the link to let that software manage your shop. You can stop it anytime.
Input
| Field | Type | Required |
|---|---|---|
shop_id | string | yes |
platform_id | string | yes |
billing_mode | string (one of shop_pays, platform_pays) | no |
Example
POST https://doingwork.work/v1/platforms/grant
content-type: application/json
Idempotency-Key: 3f1c...
{
"shop_id": "00000000-0000-4000-8000-000000000000",
"platform_id": "00000000-0000-4000-8000-000000000000"
}Output
JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.
Errors
| Code | Status | What to do |
|---|---|---|
human_only | 403 | This step happens on a hosted page the person opens themselves. Send them the link; don't try another route. |
invalid_input, invalid_token, rate_limited | Can happen on any call. See errors. |