Qodex.ai

Create Contact

POST {{baseUrl}}/contacts

Creates one contact. If such contact already exists, the existing contact will be returned without being modified.
For help with Global Contacts in CAS 360 please Click Here.

Note on creating Joint Members

If you would like to create a Joint Member you will need to create each contact (individual, company, or other) seperately. Once you have created or found the contacts you wish to use, make this call and fill in the representativeIds list with the id of each contact you want to be a part of the new Joint Member.

Make sure that the first contactId in your representativeIds list is the contact that you wish to be the primary contact of the Joint member

Request Body

KeyDatatypeMandatoryConstraints
contactTypeStringYesMust be one of 'People'/'Company'/Other Entity’/’Joint Member’
firstNameStringYesOnly mandatory if the contactType is 'People'
middleNameStringNoOnly allowed if contactType is 'People'
lastNameStringYesOnly mandatory if the contactType is 'People'
nameStringYesOnly mandatory if the contactType is 'Company'/'Other Entity'
addressIdNumberYesWill be ignored if the contactType is 'Joint Member' and the first representaive's address will be used instead. Must be a valid existing addressId for all other contact types
representativeIdsList of NumbersYesOnly mandatory if the contactType is 'Joint Member'. Can only contain contactIds of non Joint Members
titleStringNoOnly allowed if contactType is 'People'
sexStringNoOnly allowed if contactType is 'People'. Must be one of 'Male'/'Female'
emailStringNo
mobileStringNo
phone1StringNo
phone2StringNo
taxNumberStringNo
birthdayStringNoOnly allowed if contactType is 'People'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601
birthPlaceStringNoOnly allowed if contactType is 'People'
birthStateStringNoOnly allowed if contactType is 'People'. Must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT'/'Foreign'
birthCountryStringNoOnly allowed if contactType is 'People'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
skypeStringNoOnly allowed if contactType is 'People'
companyNumberStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'
businessNumberStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'
placeOfIncorporationStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
incorporationDateStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601
typeStringNoOnly allowed if the contactType is 'Other Entity'. Must be one of ‘OTHER', 'SMSF', 'PARTNERSHIP' and 'TRUST'. Will default to 'OTHER' if not specified
nationalityStringNoISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU

Request Body

{"firstName"=>"{{firstName}}", "lastName"=>"{{lastName}}", "contactType"=>"{{contactType}}", "addressId"=>"{{addressId}}", "title"=>"{{title}}", "sex"=>"{{sex}}", "email"=>"{{email}}", "mobile"=>"{{mobile}}", "phone1"=>"{{phone1}}", "phone2"=>"{{phone2}}", "taxNumber"=>"{{taxNumber}}", "birthday"=>"{{birthday}}", "birthPlace"=>"{{birthPlace}}", "birthState"=>"{{birthState}}", "birthCountry"=>"{{birthCountry}}", "type"=>"{{type}}"}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: Created

{"addressId":1995,"birthCountry":"AUSTRALIA","birthPlace":"Macdeon","birthState":"VIC","birthday":"1987-12-25","businessNumber":null,"companyNumber":null,"contactType":"People","email":"johndoe@mail.com","firstName":"John","id":3762,"incorporationDate":null,"lastName":"Doe","mobile":"0498111111","name":"John Doe","phone1":"51643726","phone2":"71726354","placeOfIncorporation":null,"representativeIds":null,"sex":"Male","skype":null,"taxNumber":"49938271","title":"Mr","nationality":null}