coreplus API

The coreplus API provides access to appointment booking related end points, such as clients, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects.

If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.

If you have any questions regarding the API documentation, please do not hesitate to contact us at integrations@coreplus.com.au

Update Client Family

URL https://<server domain name>/api/core/<version>/ClientFamily/<familyId>
Description Update an existing client family by using the familyId returned from the client family post action
Permissions Access to this function requires advanced permissions for the calling application\user

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/ClientFamily/8533a71c-390e-4d6a-8966-505a8ec55125

BODY:

{
  "title":"Mx",
  "notes": "updating dummynotes",
  "medicareCardIRN": "2",
  }
Example response
{
   "familyId":"8533a71c-390e-4d6a-8966-505a8ec55125",
   "title":"Mx",
   "surname":"young",
   "firstName":"troy",
   "dateOfBirth":"1990-02-18T00:00:00",
   "separatedDate":"2023-03-02T00:00:00",
   "relationship":"Boyfriend",
   "address":"22 Kings Rd",
   "suburb":"Melton",
   "postcode":"3337",
   "workPhone":"0300000000",
   "homePhone":"0300000000",
   "mobile":"0400000000",
   "email":"asder@bfriend.com",
   "notes":"updating dummynotes",
   "medicareCardNumber":"1234567899",
   "medicareCardIRN":"2",
   "emergencyContact":true,
   "invoiceRecipient":true,
   "mainContact":true,
   "separated":true
}

Develop with us

Use the form to sign-up and start developing with coreplus today.


Please leave this field empty.