Change Product Bundle

POST/api/v1/cases/:caseId

Changes the product bundle associated with an existing case.

cv-api-key

Productionhttps://api.care360-next.carevalidate.com/api/v1/cases/:caseId

Staginghttps://api-staging.care360-next.carevalidate.com/api/v1/cases/:caseId

Parameters

Path Parameters

caseIdstringrequired

The unique identifier (UUID) of the case.

Headers

cv-api-keystringrequired

Your unique API key for authentication.

Content-Typestringrequired

Must be application/json.

Request Body

actionstringrequired

Action to perform. Must be `CHANGE_PRODUCT_BUNDLE`.

Values:CHANGE_PRODUCT_BUNDLE

productBundleobjectrequired

Product bundle to assign.

Show 1 child property

idstringrequired

The unique identifier (UUID) of the product bundle to assign to the case.

Examples

cURL

curl --location '<BASE_URL>/api/v1/cases/:caseId' \
--header 'cv-api-key: <redacted>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "action": "CHANGE_PRODUCT_BUNDLE",
  "productBundle": {
    "id": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6"
  }
}'

Responses

▶200SuccessProduct bundle changed successfully.

{
  "status": 200,
  "success": true,
  "message": "Case product bundle changed successfully",
  "data": {
    "productBundle": {
      "id": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
      "name": "Premium Bundle"
    }
  }
}

▶400Invalid ActionReturned when the action field is not a recognized value.

{
  "status": 400,
  "success": false,
  "message": "Invalid request",
  "error": "Invalid action"
}

▶400Missing Required FieldsReturned when the productBundle.id field is missing or empty.

{
  "status": 400,
  "success": false,
  "message": "Invalid request",
  "error": "Product Bundle is required"
}

▶404Case Not FoundReturned when no case exists with the provided caseId.

{
  "status": 404,
  "success": false,
  "message": "Invalid request",
  "error": "No Case found for provided details!"
}

▶403Permission DeniedReturned when the case belongs to a different organization.

{
  "status": 403,
  "success": false,
  "message": "Invalid request",
  "error": "Permission denied!"
}

▶400Invalid Product BundleReturned when the provided product bundle ID does not exist or is invalid.

{
  "status": 400,
  "success": false,
  "message": "Invalid request",
  "error": "Invalid product bundle ID"
}

Try It Out

Try itAPI Playground

▶