API Documentation

• API documentation /
• Client /
• Create

Client: Create

Method to create a client.

Resource URL

Method

POST

Parameters

parent_id Required	ID of the parent client. Type: integer
company_name Required	Name of the client. Type: string
address1 Required	Address of the client. Type: string
address2 Optional	Address of the client. Type: string
city Required	City of the client. Type: string
province_id Optional	ID of the province of the client. Type: integer
postal_code Required	Postal code of the client. Type: string
country_id Required	ID of the country of the client. Type: integer
website Optional	Website URL of the client. Type: string
phone Optional	Phone number of the client. Type: string
fax Optional	Fax number of the client. Type: string
admin_email Required	Email address of the admin user. Type: string
admin_first_name Required	First name of the admin user. Type: string
admin_last_name Required	Last name of the admin user. Type: string
admin_title Optional	Title of the admin user. Type: string
admin_office_phone Optional	Office phone number of the admin user. Type: string
admin_mobile_phone Optional	Mobile phone number of the admin user. Type: string
admin_language Optional	Language of the admin user. Type: string - i.e. 'en_US' for English (US)
admin_timezone_id Optional	ID of the timezone of the admin user. Type: integer
admin_password Optional	Password of the admin user. Type: integer
admin_password_confirmation Optional	Password confirmation of the admin user. Type: integer
contact_same_as_admin Optional	Is the primary contact different from the admin user? Type: string - possible value '0' => false, '1' => true
contact_email Required	Email address of the primary contact user. Type: string
contact_first_name Required	First name of the primary contact user. Type: string
contact_last_name Required	Last name of the primary contact user. Type: string
contact_title Optional	Title of the primary contact user. Type: string
contact_office_phone Optional	Office phone number of the primary contact user. Type: string
contact_mobile_phone Optional	Mobile phone number of the primary contact user. Type: string
contact_language Optional	Language of the primary contact user. Type: string - i.e. en_US for English (US)
contact_timezone_id Optional	ID of the timezone of the primary contact user. Type: integer
contact_password Optional	Password of the primary contact user. Type: integer
contact_password_confirmation Optional	Password confirmation of the primary contact user. Type: integer