Create Account

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The createAccount operation will create a new account in the CRM platform.

Request

Element		Type	Description
siteID		Integer	(Mandatory) The internal siteID of the property in the IBE that the account should be created for.
accountInformation		Object	Details of the account to be created.
	nameTitle	String	Title of the account holder.
	nameFirst	String	(Mandatory) First name of the account holder.
	nameLast	String	(Mandatory) Last name of the account holder.
	addressLine1	String	Line 1 of the account holders address.
	addressLine2		Line 2 of the account holders address.
	addressTown		Town of the account holders address.
	addressZIP		Post code of the account holders address.
	addressCounty		County of the account holders address.
	addressCountry		Country of the account holders address.
	email		Email address of the account holder.
	password		(Mandatory) The password to be applied to the account.
	phoneNumber		Phone number of the account holder.
	companyName		Company name associated with the account holder.
	preferredLanguage		Preferred language of the account holder.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "createAccount",
    "siteID": 1853,
    "accountInformation": {
        "nameTitle": "Mr",
        "nameFirst": "Joe",
        "nameLast": "Bloggs",
        "addressLine1": "Avvio House, Lonsdale Road",
        "addressLine2": "National Technology Park",
        "addressTown": "Castletroy",
        "addressZIP": "V94 AW2X",
        "addressCounty": "Co. Limerick",
        "addressCountry": "IE",
        "email": "joe.blogs@gmail.com",
        "password": "password123",
        "phoneNumber": "+353 (0)61 335 680",
        "companyName": "SHR",
        "preferredLanguage": "english"
    }
}

Response

Element	Type	Description
status	String	The response status.
accountID	Integer	The internal accountID of the account created in the CRM platform.

Sample

{
  "status": "ok",
  "accountID": 8796093023822
}