Skip to main content
PATCH
/
v1
/
organisations
/
{organisationId}
/
providers
/
{providerId}
Update provider
curl --request PATCH \
  --url https://api.halth.com/v1/organisations/{organisationId}/providers/{providerId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Dr",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "profileImageUrl": "<string>"
}
'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "locationIds": [
    "<string>"
  ],
  "deleted": true,
  "mobileNumber": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "title": "Dr",
  "profileImageUrl": "<string>",
  "locationLinks": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "providerId": "<string>",
      "locationId": "<string>",
      "deleted": true,
      "acceptedTerms": true,
      "registrationStatus": "not_started",
      "applicationStatus": "not_started",
      "serviceTypeCode": "<string>",
      "categoryCode": "<string>",
      "medicare": {
        "suggestedProviderNumber": "<string>",
        "providerNumber": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "registrationLetter": "<string>"
      },
      "association": {
        "registrationLetter": "<string>"
      }
    }
  ],
  "locations": [
    {
      "id": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "timeZone": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "suburb": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postcode": "<string>",
        "country": "<string>",
        "countryCode": "<string>"
      },
      "suggestedTaxIdentifier": "<string>",
      "bookingCustomText": "<string>",
      "businessId": "<string>",
      "business": {
        "id": "<string>",
        "name": "<string>",
        "settings": {
          "autoReconciliationEnabled": true
        },
        "taxIdentifier": "<string>",
        "countryCode": "<string>",
        "structure": "public_corporation",
        "merchantId": "<string>",
        "capabilities": [
          {
            "id": "bookings_client_management",
            "status": "inactive"
          }
        ]
      }
    }
  ]
}

Path Parameters

organisationId
string
required
providerId
string
required

Body

application/json
title
enum<string>
Available options:
Dr,
Mr,
Mrs,
Ms,
Miss
firstName
string
middleName
string
lastName
string
profileImageUrl
string<uri>

Response

200 - application/json
id
string
required
createdAt
string<date-time>
required
locationIds
string[]
required
deleted
boolean
required
mobileNumber
string
email
string
firstName
string
middleName
string
lastName
string
title
enum<string>
Available options:
Dr,
Mr,
Mrs,
Ms,
Miss
profileImageUrl
string
locations
object[]