Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
Contact Sales
LogoLogo
API ReferenceNon Insurance PayersV1

Create

Beta
POST
/api/non-insurance-payers/v1
POST
/api/non-insurance-payers/v1
1import { CandidApiClient } from "candidhealth";
2
3const client = new CandidApiClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" });
4await client.nonInsurancePayers.v1.create({
5 name: "name"
6});
Try it
1{
2 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3 "name": "name",
4 "enabled": true,
5 "clinical_trials": [
6 {
7 "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8 "clinical_trial_number": "clinical_trial_number",
9 "is_active": true,
10 "name": "name",
11 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12 "clinical_trial_phase": "Phase 1"
13 },
14 {
15 "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16 "clinical_trial_number": "clinical_trial_number",
17 "is_active": true,
18 "name": "name",
19 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20 "clinical_trial_phase": "Phase 1"
21 }
22 ],
23 "description": "description",
24 "category": "category",
25 "address": {
26 "address1": "address1",
27 "city": "city",
28 "state": "AA",
29 "zip_code": "zip_code",
30 "address2": "address2",
31 "zip_plus_four_code": "zip_plus_four_code"
32 }
33}
Was this page helpful?
Previous

Toggle Enablement

Next
Built with
Toggle Enablement

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.
namestringRequired
Max 50 characters allowed
descriptionstringOptional
Max 255 characters allowed
categorystringOptional
Max 255 characters allowed
addressobjectOptional
clinical_trialslist of objectsOptional
The same name cannot be used across several clinical trials

Response

This endpoint returns an object.
non_insurance_payer_idUUID
namestring
enabledboolean
clinical_trialslist of objects
descriptionstring or null
categorystring or null
addressobject or null

Errors