Create Organization Account

Use this request to create a new organization account.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/createOrganizationAccount?userSessionId=[session id]&organizationAccount.organizationName=NeonCRM

Custom Fields

Through this API method, you can create Account Custom Field data. You cannot add data to Individual custom fields.

Custom fields have three parameters: .fieldId, .fieldOptionId, and .fieldValue. Text/textarea fields do not need any data supplied in the .OptionId field but you must include the parameter, left blank. In the same vein, select/radio fields will not need any data in the .fieldValue parameter, but you must include it (blank).

These parameters may be repeated as many times as desired to add data to multiple custom fields.

Text/Textarea Example:

&organizationAccount.customFieldDataList.customFieldData.fieldId=22
&organizationAccount.customFieldDataList.customFieldData.fieldOptionId=
&organizationAccount.customFieldDataList.customFieldData.fieldValue=EXAMPLETEXT

Select Menu/Radio Example:

&organizationAccount.customFieldDataList.customFieldData.fieldId=45
&organizationAccount.customFieldDataList.customFieldData.fieldOptionId=47
&organizationAccount.customFieldDataList.customFieldData.fieldValue=

Response

{ "createOrganizationAccountResponse": { 
    "operationResult": "SUCCESS", 
    "responseMessage": "organization account created.", 
    "responseDateTime": "2012-12-26T21:03:35.165-06:00", 
    "accountId": 123937 } 
}

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:createorganizationaccountrequest>
             <usersessionid>T1357624094982</usersessionid>
             <organizationaccount>
                <primarycontact>
                   <firstname>kevin</firstname>
                   <lastname>lee</lastname>
                   <prefix>Mrs.</prefix>
                   <phone1>0422938473</phone1>
                   <phone1type>Home</phone1type>
                   <dob>1985-10-13</dob>
                   <gender>
                      <code>M</code>
                   </gender>
                   <email1>klee@z2systems.com</email1>
                   <deceased>false</deceased>
                   <addresses>
                      <address>
                    <isprimaryaddress>true</isprimaryaddress>
                <isshippingaddress>false</isshippingaddress>
                <shippingcompanyname></shippingcompanyname>
                <shippingdeliverto></shippingdeliverto>
                <addresstype>
                   <name>Home</name>
                </addresstype>
                <addressline1>14/29 mars ST</addressline1>
                <addressline2></addressline2>
                <addressline3></addressline3>
                <addressline4></addressline4>
                <city>cheng</city>
                <state>
                   <name>ALABAMA</name>
                </state>
                <province></province>
                <county></county>
                <country>
                   <id>1</id>
                </country>
                <zipcode>6489</zipcode>
                <zipcodesuffix>1</zipcodesuffix>
                <startdate>2012-12-23</startdate>
                <enddate>2013-04-21</enddate>
                      </address>
                   </addresses>
                   <department>Dev</department>
                   <title>BA</title>
                </primarycontact>
                <customfielddatalist>
                   <customfielddata>
                      <fieldid>53</fieldid>
                     <fieldoptionid>16</fieldoptionid>
                   </customfielddata>
                </customfielddatalist>
                <organizationname>neon</organizationname>
             </organizationaccount>
          </neon:createorganizationaccountrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:createorganizationaccountresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>Organization account created.</responsemessage>
         <responsedatetime>2013-01-08T00:18:41.256-06:00</responsedatetime>
         <accountid>5789</accountid>
      </ns2:createorganizationaccountresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
organizationAccount.organizationName Yes
originDetail Yes * Required for integration partner applications. Provide your App ID as the value.
organizationAccount.primaryContact.firstName
organizationAccount.primaryContact.lastName
organizationAccount.primaryContact.middleName
organizationAccount.primaryContact.prefix Possible values come from the List Prefixes request.
organizationAccount.primaryContact.suffix
organizationAccount.primaryContact.preferredName
organizationAccount.primaryContact.salutation
organizationAccount.primaryContact.phone1
organizationAccount.primaryContact.phone1Type Possible values: Home, Work, Mobile
organizationAccount.primaryContact.phone2
organizationAccount.primaryContact.phone2Type Possible values: Home, Work, Mobile
organizationAccount.primaryContact.phone3
organizationAccount.primaryContact.phone3Type Possible values: Home, Work, Mobile
organizationAccount.primaryContact.fax
organizationAccount.primaryContact.dob Date format: YYYY-MM-DD
organizationAccount.primaryContact.gender.code Possible values can be retrieved using the List Genders method.
organizationAccount.primaryContact.gender.name Possible values can be retrieved using the List Genders method.
organizationAccount.primaryContact.deceased Possible values: true, false
organizationAccount.primaryContact.title
organizationAccount.primaryContact.department
organizationAccount.primaryContact.email1
organizationAccount.primaryContact.addresses.address.isPrimaryAddress Whether this address is the primary address. Possible values: true, false
organizationAccount.primaryContact.addresses.address.isShippingAddress Whether this address should be considered a shipping address. Possible values: true, false
organizationAccount.primaryContact.addresses.address.shippingCompanyName
organizationAccount.primaryContact.addresses.address.shippingDeliverTo
organizationAccount.primaryContact.addresses.address.addressId
organizationAccount.primaryContact.addresses.address.addressType.id Possible values can be retrieved from the List Address Types method.
organizationAccount.primaryContact.addresses.address.addressType.name Possible values can be retrieved from the List Address Types method.
organizationAccount.primaryContact.addresses.address.addressLine1
organizationAccount.primaryContact.addresses.address.addressLine2
organizationAccount.primaryContact.addresses.address.addressLine3
organizationAccount.primaryContact.addresses.address.addressLine4
organizationAccount.primaryContact.addresses.address.city
organizationAccount.primaryContact.addresses.address.state.code Possible values can be retrieved from the List States method.
organizationAccount.primaryContact.addresses.address.state.name Possible values can be retrieved from the List States method.
organizationAccount.primaryContact.addresses.address.province Only used for countries other than US and Canada. Canadian provinces can be found in the States field. Note: If you send a value for either state.code or state.name, the value in the province field will be ignored.
organizationAccount.primaryContact.addresses.address.county
organizationAccount.primaryContact.addresses.address.country.id Possible values can be retrieved from the List Countries method.
organizationAccount.primaryContact.addresses.address.country.name Possible values can be retrieved from the List Countries method.
organizationAccount.primaryContact.addresses.address.zipCode
organizationAccount.primaryContact.addresses.address.zipCodeSuffix
organizationAccount.primaryContact.addresses.address.startDate Format: YYYY-MM-DD
organizationAccount.primaryContact.addresses.address.endDate Format: YYYY-MM-DD
organizationAccount.noSolicitation This corresponds to the Do Not Contact field. Possible values: true, false.
organizationAccount.url
organizationAccount.login.username If username is provided, password must also be provided.
organizationAccount.login.password If password is provided, username must also be provided.
organizationAccount.login.orgId
organizationAccount.customFieldDataList.customFieldData.fieldId Retrieve possible account custom fields from the List Custom Fields request.
organizationAccount.customFieldDataList.customFieldData.fieldValue Required if the custom field type is a text field.
organizationAccount.customFieldDataList.customFieldData.fieldOptionId Required if the custom field type is not a text field. Possible values can be retrieved from the List Custom Fields request.
organizationAccount.source.id Possible values can be retrieved from the List Sources method.
organizationAccount.source.name Possible values can be retrieved from the List Sources method.
organizationAccount.organizationTypes.organizationType.id Possible values can be retrieved from the List Organization Types method.
organizationAccount.organizationTypes.organizationType.name Possible values can be retrieved from the List Organization Types method.
sendAcknowledgeEmail Whether to trigger the default Account Creation system email. Possible values: true, false. Default is false.
consentInformation.emailConsentStatus Possible values: GIVEN, DECLINED, NOT_ASKED. Default value is NOT_ASKED.
consentInformation.phoneConsentStatus Possible values: GIVEN, DECLINED, NOT_ASKED. Default value is NOT_ASKED.
consentInformation.mailConsentStatus Possible values: GIVEN, DECLINED, NOT_ASKED. Default value is NOT_ASKED.
consentInformation.smsConsentStatus Possible values: GIVEN, DECLINED, NOT_ASKED. Default value is NOT_ASKED.
consentInformation.dataSharingConsentStatus Possible values: GIVEN, DECLINED, NOT_ASKED. Default value is NOT_ASKED.

Response Parameters

Name Required Description
accountId Yes Account ID

Error Codes

Code Text Description
10050 Organization name is required.
10051 Organization type is required.
10052 Available organization types cannot be found.
10053 OrganizationType id is invalid.
10054 Company contact id is invalid.
10055 Address type is invalid.
10056 Address state is invalid.
10057 Address country is invalid.
10058 Organization type name is invalid.
10059 Organization type is invalid
10060 Login username is required.
10061 Login username is already exist.
10062 Login password is required.
10063 Source is invalid.
10064 CustomField id is required.
10065 CustomField id is invalid.
10067 CustomField option value is required.
10068 CustomField optionId is required.
10071 CustomField optionId is invalid.
10070 Organizaiton type is duplicated.