Hard delete rates | Candid

Hard deletes rates from the system that match the provided dimensions. This is a destructive operation and cannot be undone. If an empty dimensions object is provided, all rates will be hard deleted. The maximum number of rates this API will delete at a time is 10000. Returns the number of rates deleted and if that number is the maximum, the caller should call this API again to continue deleting rates.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

statesset of enumsRequired

zip_codesset of stringsRequired

license_typesset of enumsRequired

facility_type_codesset of enumsRequired

network_typesset of enumsRequired

payer_plan_group_idsset of UUIDsRequired

modifiersset of enumsRequired

payer_uuidUUIDOptional

organization_billing_provider_idUUIDOptional

cpt_codestringOptional

Response

This endpoint returns an integer.

$	curl -X POST https://api.joincandidhealth.com/api/fee-schedules/v3/hard-delete \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"states": [
>	"AA"
>	],
>	"zip_codes": [
>	"zip_codes"
>	],
>	"license_types": [
>	"MD"
>	],
>	"facility_type_codes": [
>	"01"
>	],
>	"network_types": [
>	"12"
>	],
>	"payer_plan_group_ids": [
>	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
>	],
>	"modifiers": [
>	"AV"
>	]
>	}'

$	curl -X POST https://api.joincandidhealth.com/api/fee-schedules/v3/hard-delete \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"states": [
>	"AA"
>	],
>	"zip_codes": [
>	"zip_codes"
>	],
>	"license_types": [
>	"MD"
>	],
>	"facility_type_codes": [
>	"01"
>	],
>	"network_types": [
>	"12"
>	],
>	"payer_plan_group_ids": [
>	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
>	],
>	"modifiers": [
>	"AV"
>	]
>	}'