start_website
Start a website
Creates a new, empty website and returns its websiteId, the editKey for changing it, the viewUrl where it can be seen, the keepUrl where the person keeps it, and the rules and size limits its files must meet. Each call makes a separate website; to change one already started, save to its websiteId instead. No account is needed: a draft lasts 7 days unless the person keeps it, and with an account connected it joins that account.
ParametersaboutbusinessNamerequired
save_website_files
Save website files
Adds or replaces files on a website and checks every page against the rules start_website returned. Files not sent stay as they are; delete_website_file removes one. Returns the viewUrl, keepUrl, pages, passed, and problems naming each rule a page breaks; the person can keep the website once passed is true. A website holds up to 40 files and 12 MB, with pages up to 300 KB and other files up to 2 MB.
ParametersfilesrequirededitKeywebsiteIdrequired
list_website_files
List website files
Lists every file saved on a website, with each path and its size in bytes, beside the viewUrl, keepUrl, pages, passed and any problems. It changes nothing. The paths are the ones read_website_file and delete_website_file take.
ParameterseditKeywebsiteIdrequired
read_website_file
Read a website file
Returns one saved file from a website with its path, encoding and content: pages, stylesheets and scripts as utf8 text, pictures and fonts as base64. It changes nothing. A path that is not saved fails with no_such_file; list_website_files shows which paths exist.
ParameterspathrequirededitKeywebsiteIdrequired
search_domains
Search for a domain name
Asks a domain registrar, live, which names can be registered, and returns up to about a dozen, each with its name, whether it is available and whether it is premium. Availability can change at any moment. Nothing is bought or held; a name is bought from the website's keep page.
Parametersqueryrequired
delete_website
Delete a website
Permanently deletes a whole website: every file, its address and its keep link. It cannot be undone. To remove one file instead, use delete_website_file. A website with a plan is refused with has_a_plan; the person removes it from their dashboard.
ParameterseditKeywebsiteIdrequired
delete_website_file
Delete a website file
Removes one saved file from a website, then checks the remaining pages against the rules start_website returned, and returns the same report as save_website_files. Other files stay. A path that is not saved fails with no_such_file. Removing index.html leaves the website with no home page until one is saved. To delete the whole website, use delete_website.
ParameterspathrequirededitKeywebsiteIdrequired
list_sites
List Your Websites
Lists the websites in the person's Jaybird Digital account, sorted by name, with each one's id, name and live address. Websites started with start_website while the account was connected, or opened with their editKey, are listed under startedWebsites (up to 20, kept ones first). An account with none gets an empty list. Needs the person to connect their account; called without one, it asks them to sign in.
Takes no parameters.