Create a payer plan

POST

/api/payer-plan-groups/v1

POST

/api/payer-plan-groups/v1

curl -X POST https://api.joincandidhealth.com/api/payer-plan-groups/v1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "plan_group_name": "plan_group_name",
  "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "plan_type": "09"
}'

{
  "is_active": true,
  "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "payer": {
    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "payer_id": "payer_id",
    "payer_name": "payer_name",
    "availity_payer_name": "availity_payer_name",
    "availity_claims_payer_id": "availity_claims_payer_id",
    "availity_eligibility_id": "availity_eligibility_id",
    "availity_remittance_payer_id": "availity_remittance_payer_id",
    "street_address": {
      "address1": "address1",
      "city": "city",
      "state": "AA",
      "zip_code": "zip_code",
      "zip_plus_four_code": "zip_plus_four_code",
      "address2": "address2"
    }
  },
  "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "plan_group_name": "plan_group_name",
  "plan_type": "09"
}

Create a payer plan.

Note: If your org does not have access to Payer Plans, you cannot use APIs to create Payer Plans.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

plan_group_namestringRequired

payer_uuidUUIDRequired

plan_typeenumRequired

Response

This endpoint returns an object.

is_activeboolean

organization_idUUID

payerobject

payer_plan_group_idUUID

payer_uuidUUID

plan_group_namestring

plan_typeenum

Errors

400

Organization Not Authorized Error

404

Entity Not Found Error

422

Payer Plan Group Already Exists HTTP Error