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
Key | Type | Mandatory | Constraints/Comments |
---|---|---|---|
title | String | No | Only allowed if contactType is ‘People’. must be one of (Mr, Ms, Mrs, Mstr, Dr, Miss) |
firstName | String | No* | Only allowed if the contactType is ‘People’ |
lastName | String | No* | Only allowed if the contactType is ‘People’ |
otherName | String | No | Only allowed if contactType is ‘People’ |
preferredName | String | No | Only allowed if contactType is ‘People’. |
name | String | Yes* | Only allowed if the contactType is ‘Company’/‘Other Entity’/'Trust' |
sex | String | No | Only allowed if contactType is ‘People’. Must be one of ‘Male’/‘Female’ |
birthday | date | No* | Only allowed if contactType is ‘People’. Must be informat yyyy-MM-dd. Must be added if person is Member or Trustee ( |
birthPlace | String | No | Only allowed if contactType is ‘People’ |
birthState | String | No | Only allowed if contactType is ‘People’.. Must be one of (‘ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT’/‘Foreign’) |
birthCountry | String | No | Only allowed if contactType is ‘People’. Must be ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 |
dateOfDeath | date | No | Only allowed if contactType is ‘People’. Must in format yyyy-MM-dd |
din | string | Director ID | |
tfn | Number | No | No |
abn | Number | No | Allowed for all ContactTypes |
acn | Number | No | Only allowed if contactType is ‘Company'. |
String | No | No | |
telephone | String | No | Only allowed if contactType is ‘People’/'Company'. |
mobile | String | No | Only allowed if contactType is ‘People’. |
smsfAuditorNumber | String | No | Only allowed if contactType is ‘People’ |
professionalBody | String | No | Only allowed if contactType is ‘People’ |
professionalBodyNumber | String | No | Only allowed if contactType is ‘People’ |
usi | String | No | Only allowed if the contactType is ‘Other Entity’ |
memberAccountNumber | String | No | Only allowed if the contactType is ‘Other Entity’. Used for RBS forms when transfeering from SMSF to another fund. |
spin | String | No | Only allowed if the contactType is ‘Other Entity’ |
establishmentDate | Date | No | must be format yyyy/MM/dd. Only allowed if the contactType is ‘Trust’ |
address | Object | No | (see Address Object below) |
Address Object
Key | Type | Mandatory | Constraints/Comments |
---|---|---|---|
streetLine1 | String | No | |
streetLine2 | String | No | |
city | String | No | |
state | String | No | Must be one of (ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT) |
postCode | String | No | |
country | String | No | Must 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
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string |
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}