Update | Candid | API Reference

import { CandidApiClient, CandidApi } from "candidhealth";
async function main() {
    const client = new CandidApiClient();
    await client.nonInsurancePayers.v1.update(CandidApi.nonInsurancePayers.v1.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
}
main();

{
  "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "name": "name",
  "enabled": true,
  "clinical_trials": [
    {
      "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "clinical_trial_number": "clinical_trial_number",
      "is_active": true,
      "name": "name",
      "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "clinical_trial_phase": "Phase 1"
    },
    {
      "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "clinical_trial_number": "clinical_trial_number",
      "is_active": true,
      "name": "name",
      "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "clinical_trial_phase": "Phase 1"
    }
  ],
  "description": "description",
  "category": "category",
  "address": {
    "address1": "address1",
    "city": "city",
    "state": "AA",
    "zip_code": "zip_code",
    "address2": "address2",
    "zip_plus_four_code": "zip_plus_four_code"
  }
}

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

non_insurance_payer_idUUIDRequired

Request

This endpoint expects an object.

namestringOptional

Max 50 characters allowed

descriptionobjectOptional

categoryobjectOptional

addressobjectOptional

Response

This endpoint returns an object.

non_insurance_payer_idUUID

namestring

enabledboolean

clinical_trialslist of objects

descriptionstring

categorystring

addressobject

Errors

404

Entity Not Found Error

409

Entity Conflict Error