Update custom schema | Candid

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

{
  "id": "ec096b13-f80a-471d-aaeb-54b021c9d582",
  "name": "General Medicine and Health",
  "fields": [
    {
      "key": "provider_category",
      "type": "STRING"
    },
    {
      "key": "is_urgent_care",
      "type": "BOOLEAN"
    },
    {
      "key": "bmi",
      "type": "DOUBLE"
    },
    {
      "key": "age",
      "type": "INTEGER"
    },
    {
      "key": "visit_type",
      "type": "STRING"
    }
  ],
  "description": "Values collected during all visits"
}

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

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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

descriptionstring

Errors

403

Unauthorized Error

404

Entity Not Found Error

422

Schema Validation HTTP Failure