v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Contact

Create contact

post/contacts

Request body

address_1string nullable

address_2string nullable

address_3string nullable

citystring nullable

company_namestring nullable

country_codestring nullable

ISO 3166-1 country code

doctor_type'general_practitioner' | 'specialist' nullable

emailstring nullable

first_namestring nullable

last_namestring nullable

notesstring nullable

occupationstring nullable

post_codestring nullable

preferred_namestring nullable

provider_numberstring nullable

statestring nullable

titlestring nullable

type_code0 | 1 | 2

Example request

{
  "country_code": "AU",
  "phone_numbers": [
    {
      "number": "0-123-456-78"
    }
  ]
}

Response

Resource was created

address_1string nullable

address_2string nullable

address_3string nullable

archived_atstring date-time nullable

citystring nullable

company_namestring nullable

countrystring nullable

country_codestring nullable

ISO 3166-1 country code

created_atstring date-time

deleted_atstring date-time nullable

doctor_type'general_practitioner' | 'specialist' nullable

emailstring nullable

first_namestring nullable

idstring int64

last_namestring nullable

notesstring nullable

occupationstring nullable

post_codestring nullable

preferred_namestring nullable

provider_numberstring nullable

statestring nullable

titlestring nullable

type'Doctor' | '3rd Party Payer' | 'Standard' nullable

type_code0 | 1 | 2

updated_atstring date-time

Example response

{
  "country_code": "AU",
  "links": {
    "self": "https://api.au1.cliniko.com/v1/contacts/1"
  },
  "phone_numbers": [
    {
      "normalized_number": "39012345678",
      "number": "0-123-456-78"
    }
  ]
}