shops.signUp
Create a shop for an owner who has already accepted the current Terms and Privacy. That acceptance is for the person and covers every shop they own or join. Send accept_terms true, the shop name, the jurisdiction and the owner's name and email. This does not accept for the owner and it does not email the Terms. If the owner has not accepted yet, the call is refused and names the missing document and /p/legal. The reply has an agent key for the new shop, shown once.
| |
|---|
| Who | Agents can call this |
| REST | POST /v1/signups |
| MCP tool | shops_signUp |
| Writes | yes, send an Idempotency-Key |
| Area | Shop |
When to use it
Create a shop for an owner who has already accepted the current Terms and Privacy. That acceptance is for the person and covers every shop they own or join.
What to tell the owner
Say what you did in plain words and what happens next.
| Field | Type | Required |
|---|
shop_name | string | yes |
jurisdiction | string | yes |
owner_name | string | yes |
owner_email | string | yes |
accept_terms | boolean | yes |
accept_terms_version | string | no |
agent_name | string | no |
partner_code | string | no |
referral_code | string | no |
lead_code | string | no |
Example
POST https://doingwork.work/v1/signups
content-type: application/json
Idempotency-Key: 3f1c...
{
"shop_name": "...",
"jurisdiction": "US-ID",
"owner_name": "...",
"owner_email": "...",
"accept_terms": true
}
Output
| Field | Type | Always there |
|---|
shop_id | string | yes |
key_id | string | yes |
key | string | yes |
shown_once | boolean | yes |
scopes | array | yes |
terms_version | string | yes |
terms_url | string | yes |
partner_code | string | no |
lead_code | string | no |
{
"shop_id": "00000000-0000-4000-8000-000000000000",
"key_id": "00000000-0000-4000-8000-000000000000",
"key": "...",
"shown_once": true,
"scopes": [
"..."
],
"terms_version": "...",
"terms_url": "..."
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |