Sites

Suggest an address for a site

Checks the address the user wants (slug) and suggests up to three available ones based on name. Use it before POST /sites to show the user a suggestion and let them pick or change it. Nothing is reserved. Names that look like a bank, login, payment or support page, a brand, or anything with hypamoon in it are refused.

get/sites/address-suggestions

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/sites/address-suggestions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Query parameters

namestring

The name of the site or business, like Acme Plumbing.

slugstring

The address the user would like, like acme-plumbing.

Response

The requested address, checked, and available suggestions.

Changes

No recorded changes to this operation across all 1 revision of this API.