POST https://api.anypress.io/v1/tenants creates a site. These are the fields you’ll use most often. Every field, with examples, is in the API reference.
| Field | What it’s for |
|---|---|
name |
The site’s name. Its free address is made from it, for example rose-and-fern.anypress.site. Required |
externalId |
Your own id for the site: the order, deal or form entry number. Letters, numbers and dashes only. Sending the same create again answers with the site already made, so retries are safe |
wordPressUserName, wordPressUserEmail |
The client’s WordPress login. Send both or neither |
wordPressUserRole |
Their WordPress role, usually administrator |
groupName |
Which of your starting sites to copy, by its group name. Leave it out to use your current one |
size |
small, medium or large. Small if you leave it out |
customDomainName |
The client’s own domain, if they already have one. You can add it later instead |
productId |
Partner keys only: which storefront the site belongs to. Sent in the URL, not the body |
What comes back #
The answer arrives straight away, before the site is built:
{ "id": "…", "externalId": "pay-3QxK81Lm", "baseDomain": "rose-and-fern.anypress.site" }Check progress with GET /v1/tenants?externalId=… (statusCode 0 is building, 1 is done, 2 is failed), or get the tenant.ready webhook instead. See Email the client when their site is ready.
Common answers #
| Answer | Why |
|---|---|
| 403 | Wrong key or secret |
409 externalId … is already in use by another store |
That id belongs to a different site |
400 Domain … is already in use |
Another site already has that domain |
400 productId is required with a partner key |
Add ?productId= to the URL |
