Skip to main content
PATCH
/
v1
/
organisations
/
{organisationId}
/
providers
/
{providerId}
/
location-links
/
{locationId}
Update provider location link
curl --request PATCH \
  --url https://api.halth.com/v1/organisations/{organisationId}/providers/{providerId}/location-links/{locationId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "categoryCode": "<string>"
}
'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "providerId": "<string>",
  "locationId": "<string>",
  "deleted": true,
  "acceptedTerms": true,
  "categoryCode": "<string>",
  "medicare": {
    "suggestedProviderNumber": "<string>",
    "providerNumber": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "registrationLetter": "<string>"
  },
  "association": {
    "registrationLetter": "<string>"
  }
}

Path Parameters

​
organisationId
string
required
​
providerId
string
required
​
locationId
string
required

Body

application/json
​
serviceTypeCode
enum<string>
Available options:
F,
3,
4,
5,
6,
7,
8,
9,
P,
M,
1,
E,
U,
C,
S,
B,
N,
H,
Z,
0,
2,
V,
T,
O,
A,
L,
R,
G,
Q,
X,
W,
I,
K,
Y,
D
​
categoryCode
string
​
medicare
object
​
association
object

Response

200 - application/json
​
id
string
required
​
createdAt
string<date-time>
required
​
providerId
string
required
​
locationId
string
required
​
deleted
boolean
required
​
acceptedTerms
boolean
required
​
registrationStatus
enum<string>
required
Available options:
not_started,
registered
​
applicationStatus
enum<string>
required
Available options:
not_started,
pending,
approved
​
serviceTypeCode
enum<string>
Available options:
F,
3,
4,
5,
6,
7,
8,
9,
P,
M,
1,
E,
U,
C,
S,
B,
N,
H,
Z,
0,
2,
V,
T,
O,
A,
L,
R,
G,
Q,
X,
W,
I,
K,
Y,
D
​
categoryCode
string
​
medicare
object
​
association
object