Update custom schema

Beta

PATCH

/api/custom-schemas/v1/:schema_id

Update the name, description, or keys on a preexisting schema.

Path parameters

schema_idUUIDRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

fields_to_addlist of objectsOptional

A list of typed entries to add to schema. Only additive modifications are permitted.

Response

This endpoint returns an object.

idUUID

namestring

fieldslist of objects

descriptionstringOptional

Errors

PATCH

1 curl -X PATCH https://api.joincandidhealth.com/api/custom-schemas/v1/ec096b13-f80a-471d-aaeb-54b021c9d582 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "General Medicine and Health",
6   "description": "Values collected during all visits",
7   "fields_to_add": [
8     {
9       "key": "visit_type",
10       "type": "STRING"
11     }
12   ]
13 }'

200Updated

1 {
2   "id": "ec096b13-f80a-471d-aaeb-54b021c9d582",
3   "name": "General Medicine and Health",
4   "fields": [
5     {
6       "key": "provider_category",
7       "type": "STRING"
8     },
9     {
10       "key": "is_urgent_care",
11       "type": "BOOLEAN"
12     },
13     {
14       "key": "bmi",
15       "type": "DOUBLE"
16     },
17     {
18       "key": "age",
19       "type": "INTEGER"
20     },
21     {
22       "key": "visit_type",
23       "type": "STRING"
24     }
25   ],
26   "description": "Values collected during all visits"
27 }

Built with

1	curl -X PATCH https://api.joincandidhealth.com/api/custom-schemas/v1/ec096b13-f80a-471d-aaeb-54b021c9d582 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "General Medicine and Health",
6	"description": "Values collected during all visits",
7	"fields_to_add": [
8	{
9	"key": "visit_type",
10	"type": "STRING"
11	}
12	]
13	}'

1	{
2	"id": "ec096b13-f80a-471d-aaeb-54b021c9d582",
3	"name": "General Medicine and Health",
4	"fields": [
5	{
6	"key": "provider_category",
7	"type": "STRING"
8	},
9	{
10	"key": "is_urgent_care",
11	"type": "BOOLEAN"
12	},
13	{
14	"key": "bmi",
15	"type": "DOUBLE"
16	},
17	{
18	"key": "age",
19	"type": "INTEGER"
20	},
21	{
22	"key": "visit_type",
23	"type": "STRING"
24	}
25	],
26	"description": "Values collected during all visits"
27	}