Redirecting…

Create a Customer

Creates a customer account of the API key owners account.

Parameters

Name Type Description
api_key string your YikeSite API key (required)
customer[account_name] string the name of the account (required)
customer[account_subdomain] string the subdomain to use for this account (required)
customer[user_name] string name of the admin user (required)
customer[user_email] string email address of the user (required)
customer[user_password] string password for the user (required)
customer[user_password_confirmation] string should be exactly the same as customer[user_password] (required)
customer[skip_default_pages] string should be 1, any other value treated as a negative value and default pages will be created (optional)

JSON Example

POST https://api.yikesite.com/api/customers.json?api_key=<api_key>
  &customer[account_name]=johndoe
  &customer[account_subdomain]=johndoe
  &customer[user_name]=John%20Doe
  &customer[user_email]=john@doe.com
  &customer[user_password]=johndoe1234
  &customer[user_password_confirmation]=johndoe1234

On success, the newly created user will be emailed with login instructions, and the following JSON will be returned,

{
  "response": true,
  "errors": null
}

When parameters are incorrectly formatted,

{
  "response": false,
  "errors": "Incorrect parameters."
}

On failure,

{
  "response": false,
  "errors": ["Your URL has already been taken"]
}