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.

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

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.

Input

FieldTypeRequired
shop_namestringyes
jurisdictionstringyes
owner_namestringyes
owner_emailstringyes
accept_termsbooleanyes
accept_terms_versionstringno
agent_namestringno
partner_codestringno
referral_codestringno
lead_codestringno

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
partner_codestringno
lead_codestringno
{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "key_id": "00000000-0000-4000-8000-000000000000",
  "key": "...",
  "shown_once": true,
  "scopes": [
    "..."
  ],
  "terms_version": "...",
  "terms_url": "..."
}

Errors

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