Skip to content
API reference/
API Reference
/
/
Update Pathway

Update Pathway

Request

Updates a pathway for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
titlestring
summarystring or null
in_hoursboolean
out_of_hoursboolean
suspendedboolean
orderinteger, > 0
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/pathways/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "summary": "string",
    "in_hours": true,
    "out_of_hours": true,
    "suspended": true,
    "order": 0
  }'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
titlestringrequired
summarystring or nullrequired
in_hoursboolean or nullrequired
out_of_hoursboolean or nullrequired
suspendedboolean or nullrequired
ordernumber or nullrequired
created_atstring or null, (date-time)required
updated_atstring or null, (date-time)required
Response
{
  "id": "string",
  "title": "string",
  "summary": "string",
  "in_hours": true,
  "out_of_hours": true,
  "suspended": true,
  "order": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}