Qodex.ai

Update Contacts

PUT {{baseUrl}}/sf/contacts/{{contactId}}

Allows you to update details for a single contact.

API Scopes

The following API scopes can access this resouce - smsf_partner

Request Body

KeyTypeMandatoryConstraints/Comments
titleStringNoOnly allowed if contactType is ‘People’. must be one of (Mr, Ms, Mrs, Mstr, Dr, Miss)
firstNameStringNo*Only allowed if the contactType is ‘People’
lastNameStringNo*Only allowed if the contactType is ‘People’
otherNameStringNoOnly allowed if contactType is ‘People’
preferredNameStringNoOnly allowed if contactType is ‘People’.
nameStringYes*Only allowed if the contactType is ‘Company’/‘Other Entity’/'Trust'
sexStringNoOnly allowed if contactType is ‘People’. Must be one of ‘Male’/‘Female’
birthdaydateNo*Only allowed if contactType is ‘People’. Must be informat yyyy-MM-dd. Must be added if person is Member or Trustee (
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’. Must be ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
dateOfDeathdateNoOnly allowed if contactType is ‘People’. Must in format yyyy-MM-dd
dinstringDirector ID
tfnNumberNoNo
abnNumberNoAllowed for all ContactTypes
acnNumberNoOnly allowed if contactType is ‘Company'.
emailStringNoNo
telephoneStringNoOnly allowed if contactType is ‘People’/'Company'.
mobileStringNoOnly allowed if contactType is ‘People’.
smsfAuditorNumberStringNoOnly allowed if contactType is ‘People’
professionalBodyStringNoOnly allowed if contactType is ‘People’
professionalBodyNumberStringNoOnly allowed if contactType is ‘People’
usiStringNoOnly allowed if the contactType is ‘Other Entity’
memberAccountNumberStringNoOnly allowed if the contactType is ‘Other Entity’. Used for RBS forms when transfeering from SMSF to another fund.
spinStringNoOnly allowed if the contactType is ‘Other Entity’
establishmentDateDateNomust be format yyyy/MM/dd. Only allowed if the contactType is ‘Trust’
addressObjectNo(see Address Object below)

Address Object

KeyTypeMandatoryConstraints/Comments
streetLine1StringNo
streetLine2StringNo
cityStringNo
stateStringNoMust be one of (ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT)
postCodeStringNo
countryStringNoMust be a country code as defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Request Body

{"firstName"=>"{{firstName}}", "lastName"=>"{{lastName}}", "address"=>{"streetLine1"=>"{{streetLine1}}", "suburb"=>"{{suburb}}", "state"=>"{{state}}", "postCode"=>"{{postCode}}", "country"=>"{{country}}"}, "title"=>"{{title}}", "sex"=>"{{sex}}", "email"=>"{{email}}", "mobile"=>"{{mobile}}", "phone1"=>"{{phone1}}", "birthday"=>"{{birthday}}", "birthPlace"=>"{{birthPlace}}", "birthState"=>"{{birthState}}", "birthCountry"=>"birthCountry", "entityRelationships"=>["{{entityRelationships}}"]}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: OK

{"abn":"99159300464","accountId":null,"acn":null,"address":{"addressId":2261598,"city":null,"country":"AU","postCode":"3000","state":"VIC","streetLine1":"78 Test Road","streetLine2":null},"birthCountry":"AU","birthPlace":"Macdeon","birthState":"VIC","birthday":"1977-12-25","booleanForSolePurposeSMSFCorpTrustee":null,"contactId":"8ad08a8b74fb078a0174fb0bf5e30000","contactType":"People","dateOfDeath":null,"email":"johndoe@mail.com","entityRelationships":null,"establishmentDate":null,"firstName":"John","lastName":"Doe","memberAccountNumber":null,"mobile":"61417000999","name":null,"otherName":"TT","phone":"98581111","preferredName":null,"professionalBody":null,"professionalBodyNumber":null,"representativeIds":[],"sex":"MALE","smsfAuditorNumber":null,"solePurposeSMSFCorpTrustee":null,"spin":null,"telephone":"98581111","tfn":"Provided","title":"Mr","usi":null}