Update Contact
PUT {{baseUrl}}/contacts/:contactId
Updates contact details (non Joint-member)
Will update all of the details of the contact represented by its id. Any missing details will be set to ‘null’.
Constraint: contactType cannot be ‘Joint Member’
Request Body
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| firstName | String | No | Only allowed if the contactType is 'People' |
| middleName | String | No | Only allowed if contactType is 'People' |
| lastName | String | No | Only allowed if the contactType is 'People' |
| name | String | No | Only allowed if the contactType is 'Company'/'Other Entity' |
| addressId | Number | No | Only allowed if the contactType is 'People'. Must be a valid existing addressId |
| title | String | No | Only allowed if the contactType is 'People' |
| sex | String | No | Only allowed if the contactType is 'People'. Must be one of 'Male'/'Female' |
| String | No | ||
| mobile | String | No | |
| phone1 | String | No | |
| phone2 | String | No | |
| taxNumber | String | No | |
| birthday | String | No | Only allowed if contactType is 'People'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| 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'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 |
| skype | String | No | Only allowed if contactType is 'People' |
| businessNumber | String | No | Only allowed if the contactType is 'Company' |
| placeOfIncorportaion | String | No | Only allowed if the contactType is 'Company'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 |
| incorporationDate | String | No | Only allowed if the contactType is 'Company'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| nationality | String | No | ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU |
Request Body
["<", "o", "b", "j", "e", "c", "t", ">"]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
{"firstName":"John","lastName":"Doe","contactType":"People","addressId":"172843","title":"Mr","sex":"Male","email":"johndoe@mail.com","mobile":"0498111111","phone1":"51643726","phone2":"71726354","taxNumber":"49938271","birthday":"1987-12-25","birthPlace":"Macdeon","birthState":"VIC","birthCountry":"Australia","nationality":null}