Private preview of the new site. Not live.

shops.signUp

Sign a new shop up for its owner in one call. Send accept_terms: true to accept the Terms of Service for the shop, with the owner's name and email. The reply has a link to the Terms, the version, and an agent key for the new shop; every feature works right away. We email the owner the full Terms with the version and date.

WhoAgents can call this
RESTPOST /v1/signups
MCP toolshops_signUp
Writesyes, send an Idempotency-Key
AreaShop

When to use it

To start a new shop for someone, call shops.signUp once with accept_terms true, the shop name, the jurisdiction and the owner's name and email. That accepts the Terms of Service for the shop.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
shop_namestringyes
jurisdictionstringyes
owner_namestringyes
owner_emailstringyes
accept_termsbooleanyes
accept_terms_versionstringno
agent_namestringno

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

FieldTypeAlways there
shop_idstringyes
key_idstringyes
keystringyes
shown_oncebooleanyes
scopesarrayyes
terms_versionstringyes
terms_urlstringyes
owner_emailedobjectyes
owner_emailed.tostringyes
owner_emailed.atstringyes
owner_emailed.whatstringyes
{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "key_id": "00000000-0000-4000-8000-000000000000",
  "key": "...",
  "shown_once": true,
  "scopes": [
    "..."
  ],
  "terms_version": "...",
  "terms_url": "...",
  "owner_emailed": {
    "to": "...",
    "at": "...",
    "what": "..."
  }
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.