Beta

Create

POST

/api/non-insurance-payers/v1

POST

1 from candid import CandidApiClient
2 from candid.resources.commons import State, StreetAddressShortZip
3 from candid.resources.non_insurance_payers.resources.v_1 import (
4     CreateNonInsurancePayerRequest,
5 )
6 
7 client = CandidApiClient(
8     client_id="YOUR_CLIENT_ID",
9     client_secret="YOUR_CLIENT_SECRET",
10 )
11 client.non_insurance_payers.v_1.create(
12     request=CreateNonInsurancePayerRequest(
13         name="string",
14         description="string",
15         category="string",
16         address=StreetAddressShortZip(
17             address_1="123 Main St",
18             address_2="Apt 1",
19             city="New York",
20             state=State.NY,
21             zip_code="10001",
22             zip_plus_four_code="1234",
23         ),
24     ),
25 )

Play

200Successful

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 }

Request

This endpoint expects an object.

namestringRequired

Max 50 characters allowed

descriptionstringOptional

Max 255 characters allowed

categorystringOptional

Max 255 characters allowed

addressobjectOptional

Response

This endpoint returns an object.

non_insurance_payer_idUUID

namestring

enabledboolean

clinical_trialslist of objects