Qodex.ai

Update Contact

PATCH {{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 NOT be updated.

Constraint: contactType cannot be ‘Joint Member’

Request Body

KeyDatatypeMandatoryConstraints
firstNameStringNoOnly allowed if the contactType is 'People'
middleNameStringNoOnly allowed if contactType is 'People'
lastNameStringNoOnly allowed if the contactType is 'People'
nameStringNoOnly allowed if the contactType is 'Company'/'Other Entity'
addressIdNumberNoOnly allowed if the contactType is 'People'. Must be a valid existing addressId
titleStringNoOnly allowed if the contactType is 'People'
sexStringNoOnly allowed if the 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'
businessNumberStringNoOnly allowed if the contactType is 'Company'
placeOfIncorportaionStringNoOnly allowed if the contactType is 'Company'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
incorporationDateStringNoOnly allowed if the contactType is 'Company'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601

Request Body

{"addressId"=>1675073, "birthCountry"=>"AUSTRALIA", "birthPlace"=>"CLAYTON", "birthState"=>"VIC", "birthday"=>"2001-08-01", "businessNumber"=>"", "companyNumber"=>nil, "contactType"=>"People", "email"=>"c@v.com", "firstName"=>"Christian", "id"=>1941877, "incorporationDate"=>nil, "lastName"=>"Vieri", "middleName"=>"", "mobile"=>nil, "name"=>"Christian Vieri", "nationality"=>nil, "phone1"=>nil, "phone2"=>nil, "placeOfIncorporation"=>nil, "representativeIds"=>nil, "sex"=>nil, "skype"=>nil, "taxNumber"=>"", "title"=>nil}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: OK

{"addressId":1675073,"birthCountry":"AUSTRALIA","birthPlace":"CLAYTON","birthState":"VIC","birthday":"2001-08-01","businessNumber":"","companyNumber":null,"contactType":"People","email":"c@v.com","firstName":"Christian","id":1941877,"incorporationDate":null,"lastName":"Vieri","middleName":"","mobile":null,"name":"Christian Vieri","nationality":null,"phone1":null,"phone2":null,"placeOfIncorporation":null,"representativeIds":null,"sex":null,"skype":null,"taxNumber":"","title":null}