Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
contact

Create single contact

Create single contact

post/contacts

Request body

typestring required

Contact type

namestring required

Contact name

titlestring nullable

Contact title

firstNamestring nullable

Contact first name

lastNamestring nullable

Contact last name

preferredNamestring nullable

Contact preferred name

occupationstring nullable

Contact occupation

companyNamestring nullable

Contact company name

providerNumberstring nullable

Contact provider number

doctorType'GP' | 'Specialist' nullable

Contact doctor type

emailstring email required

Contact email

addressL1string nullable

Contact address line 1

addressL2string nullable

Contact address line 2

addressL3string nullable

Contact address line 3

suburbstring nullable

Contact city

statestring nullable

Contact state

postalCodestring nullable

Contact post code

countrystring nullable

Contact country

Example request

{
  "type": "Standard",
  "name": "Plan Manager",
  "title": "Mr.",
  "firstName": "Harry",
  "lastName": "Potter",
  "preferredName": "Harry",
  "occupation": "Contractor",
  "companyName": "splose",
  "providerNumber": "12345678",
  "doctorType": "GP",
  "email": "harry@hogwarts.edu",
  "addressL1": "123 King William Street",
  "suburb": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ]
}

Response

Successfully created contact

idinteger required

Contact id

typestring nullable required

Contact type

namestring nullable required

Contact name

titlestring nullable required

Contact title

firstNamestring nullable required

Contact first name

lastNamestring nullable required

Contact last name

preferredNamestring nullable required

Contact preferred name

occupationstring nullable required

Contact occupation

companyNamestring nullable required

Contact company name

providerNumberstring nullable required

Contact provider number

doctorTypestring nullable required

Contact doctor type

associatedPatientIdsnumber[] nullable required

The associated patients' id in this contact

associatedInvoiceIdsnumber[] nullable required

The associated invoices' id in this contact

associatedCaseIdsnumber[] nullable required

The associated invoices' id in this contact

emailstring nullable required

Contact email

addressL1string nullable required

Contact address line 1

addressL2string nullable required

Contact address line 2

addressL3string nullable required

Contact address line 3

suburbstring nullable required

Contact city

statestring nullable required

Contact state

postalCodestring nullable required

Contact post code

countrystring nullable required

Contact country

archivedboolean nullable

Whether the contact has been archived

Example response

{
  "id": 1,
  "type": "Standard",
  "name": "Plan Manager",
  "title": "Mr.",
  "firstName": "Harry",
  "lastName": "Potter",
  "preferredName": "Harry",
  "occupation": "Contractor",
  "companyName": "splose",
  "providerNumber": "12345678",
  "doctorType": "GP",
  "email": "harry@hogwarts.edu",
  "addressL1": "123 King William Street",
  "suburb": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ]
}