Beta

Update

PATCH

/api/non-insurance-payers/v1/:non_insurance_payer_id

PATCH

1 import uuid
2 
3 from candid import CandidApiClient
4 from candid.resources.non_insurance_payers.resources.v_1 import (
5     NonInsurancePayerAddressUpdate,
6     NonInsurancePayerCategoryUpdate,
7     NonInsurancePayerDescriptionUpdate,
8     NonInsurancePayerUpdateRequest,
9 )
10 
11 client = CandidApiClient(
12     client_id="YOUR_CLIENT_ID",
13     client_secret="YOUR_CLIENT_SECRET",
14 )
15 client.non_insurance_payers.v_1.update(
16     non_insurance_payer_id=uuid.UUID(
17         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18     ),
19     request=NonInsurancePayerUpdateRequest(
20         name="string",
21         description=NonInsurancePayerDescriptionUpdate(),
22         category=NonInsurancePayerCategoryUpdate(),
23         address=NonInsurancePayerAddressUpdate(),
24     ),
25 )

Play

200Updated

1 {
2   "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "name": "string",
4   "enabled": true,
5   "clinical_trials": [
6     {
7       "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8       "clinical_trial_number": "string",
9       "is_active": true,
10       "name": "string",
11       "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12       "clinical_trial_phase": "Phase 1"
13     }
14   ],
15   "description": "string",
16   "category": "string",
17   "address": {
18     "address1": "string",
19     "city": "string",
20     "state": "AA",
21     "zip_code": "string",
22     "address2": "string",
23     "zip_plus_four_code": "string"
24   }
25 }

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

descriptionstringOptional

categorystringOptional

addressobjectOptional

Update

Path parameters

Headers

Request

Response

Errors