{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants Case Management API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Case Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a Case Association.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/associations/:associationId",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "associationId",
                "value": "",
                "type": "path",
                "description": "Case association identifier."
              }
            ]
          },
          "docs": "Get a Case Association."
        },
        {
          "info": {
            "name": "Query for Case associations by interaction.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/associations/query"
          },
          "docs": "Query for Case associations by interaction."
        },
        {
          "info": {
            "name": "Get a list of Case associations for the Case.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/associations",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              }
            ]
          },
          "docs": "Get a list of Case associations for the Case."
        },
        {
          "info": {
            "name": "Create a Case association.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/associations",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              }
            ]
          },
          "docs": "Create a Case association."
        },
        {
          "info": {
            "name": "Query for Caseplans.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/query"
          },
          "docs": "This endpoint supports two filtering modes. The recommended approach uses 'filters' (generic filter model) and 'attributes' (field projection). During the migration period, the legacy fields 'name', 'nameSearchType', and 'divisionIds' remain available as an alternative."
        },
        {
          "info": {
            "name": "Get a Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Get a Caseplan."
        },
        {
          "info": {
            "name": "Update the attributes of a Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Update the attributes of a Caseplan."
        },
        {
          "info": {
            "name": "Delete a Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Delete a Caseplan."
        },
        {
          "info": {
            "name": "Publish Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/publish",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Publish Caseplan."
        },
        {
          "info": {
            "name": "Create Caseplan version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Create Caseplan version."
        },
        {
          "info": {
            "name": "Get a Caseplan version.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              }
            ]
          },
          "docs": "Get a Caseplan version."
        },
        {
          "info": {
            "name": "Get the intake settings for a Caseplan version.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId/intakesettings",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              }
            ]
          },
          "docs": "Get the intake settings for a Caseplan version."
        },
        {
          "info": {
            "name": "Update the intake settings for a Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/intakesettings",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Update the intake settings for a Caseplan."
        },
        {
          "info": {
            "name": "Get the data schemas for a Caseplan version.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId/dataschemas",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              }
            ]
          },
          "docs": "Get the data schemas for a Caseplan version."
        },
        {
          "info": {
            "name": "Add a data schema to a draft Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/dataschemas",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              }
            ]
          },
          "docs": "Add a data schema to a draft Caseplan."
        },
        {
          "info": {
            "name": "Update a data schema on a draft Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/dataschemas/:schemaKeyName",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "schemaKeyName",
                "value": "",
                "type": "path",
                "description": "Schema key (for example \"default\")."
              }
            ]
          },
          "docs": "Update a data schema on a draft Caseplan."
        },
        {
          "info": {
            "name": "Remove a data schema from a draft Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/dataschemas/:schemaKeyName",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "schemaKeyName",
                "value": "",
                "type": "path",
                "description": "Schema key (for example \"default\")."
              }
            ]
          },
          "docs": "Remove a data schema from a draft Caseplan."
        },
        {
          "info": {
            "name": "Get a list of Caseplans.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor that points to the end of the previously returned set of Caseplans."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of Caseplans to return. Maximum is 200."
              },
              {
                "name": "customerIntentId",
                "value": "",
                "type": "query",
                "description": "Filter by customer intent."
              },
              {
                "name": "divisionIds",
                "value": "",
                "type": "query",
                "description": "Filter by divisions."
              }
            ]
          },
          "docs": "Get a list of Caseplans."
        },
        {
          "info": {
            "name": "Create a Caseplan.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans"
          },
          "docs": "Create a Caseplan."
        },
        {
          "info": {
            "name": "Get a Case.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a Case."
        },
        {
          "info": {
            "name": "Delete a Case.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              }
            ]
          },
          "docs": "Delete a Case."
        },
        {
          "info": {
            "name": "Update priority of a Case.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/priority",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              }
            ]
          },
          "docs": "Update priority of a Case."
        },
        {
          "info": {
            "name": "Update the due date of a Case.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/datedue",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              }
            ]
          },
          "docs": "Update the due date of a Case."
        },
        {
          "info": {
            "name": "Update summary of a Case.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/summary",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              }
            ]
          },
          "docs": "Update summary of a Case."
        },
        {
          "info": {
            "name": "Get a list of Cases for an External Contact.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/externalcontacts/:externalContactId",
            "params": [
              {
                "name": "externalContactId",
                "value": "",
                "type": "path",
                "description": "External contact identifier."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor pointing to the end of the previously returned page of Cases."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of Cases to return (maximum 200)."
              },
              {
                "name": "divisionIds",
                "value": "",
                "type": "query",
                "description": "Filter by divisions."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a list of Cases for an External Contact."
        },
        {
          "info": {
            "name": "Get a Case by reference.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/references/:referenceId",
            "params": [
              {
                "name": "referenceId",
                "value": "",
                "type": "path",
                "description": "Case reference."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a Case by reference."
        },
        {
          "info": {
            "name": "Create a Case.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases"
          },
          "docs": "Create a Case."
        },
        {
          "info": {
            "name": "Get a Terminate Job for a Case.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/terminate/jobs/:jobId",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Terminate Job identifier."
              }
            ]
          },
          "docs": "Get a Terminate Job for a Case."
        },
        {
          "info": {
            "name": "Create a Terminate Job for a Case.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/terminate/jobs",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              }
            ]
          },
          "docs": "Create a Terminate Job for a Case."
        },
        {
          "info": {
            "name": "Update the attributes of a Stageplan.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/stageplans/:stageplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "stageplanId",
                "value": "",
                "type": "path",
                "description": "Stageplan identifier."
              }
            ]
          },
          "docs": "Update the attributes of a Stageplan."
        },
        {
          "info": {
            "name": "Get a Stageplan.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId/stageplans/:stageplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              },
              {
                "name": "stageplanId",
                "value": "",
                "type": "path",
                "description": "Stageplan identifier."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a Stageplan."
        },
        {
          "info": {
            "name": "Get a list of Stageplans.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId/stageplans",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a list of Stageplans."
        },
        {
          "info": {
            "name": "Get a Stage.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/stages/:stageId",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "stageId",
                "value": "",
                "type": "path",
                "description": "Stage identifier."
              }
            ]
          },
          "docs": "Get a Stage."
        },
        {
          "info": {
            "name": "Get a list of Stages.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/stages",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              }
            ]
          },
          "docs": "Get a list of Stages."
        },
        {
          "info": {
            "name": "Update the attributes of a Stepplan.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/stageplans/:stageplanId/stepplans/:stepplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "stageplanId",
                "value": "",
                "type": "path",
                "description": "Stageplan identifier."
              },
              {
                "name": "stepplanId",
                "value": "",
                "type": "path",
                "description": "Stepplan identifier."
              }
            ]
          },
          "docs": "Update the attributes of a Stepplan."
        },
        {
          "info": {
            "name": "Get a Stepplan.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId/stageplans/:stageplanId/stepplans/:stepplanId",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              },
              {
                "name": "stageplanId",
                "value": "",
                "type": "path",
                "description": "Stageplan identifier."
              },
              {
                "name": "stepplanId",
                "value": "",
                "type": "path",
                "description": "Stepplan identifier."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a Stepplan."
        },
        {
          "info": {
            "name": "Get a list of Stepplans.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/caseplans/:caseplanId/versions/:versionId/stageplans/:stageplanId/stepplans",
            "params": [
              {
                "name": "caseplanId",
                "value": "",
                "type": "path",
                "description": "Caseplan identifier."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "Caseplan version identifier."
              },
              {
                "name": "stageplanId",
                "value": "",
                "type": "path",
                "description": "Stageplan identifier."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              },
              {
                "name": "expands",
                "value": "",
                "type": "query",
                "description": "Fields to expand."
              }
            ]
          },
          "docs": "Get a list of Stepplans."
        },
        {
          "info": {
            "name": "Get a Step.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/stages/:stageId/steps/:stepId",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "stageId",
                "value": "",
                "type": "path",
                "description": "Stage identifier."
              },
              {
                "name": "stepId",
                "value": "",
                "type": "path",
                "description": "Step identifier."
              }
            ]
          },
          "docs": "Get a Step."
        },
        {
          "info": {
            "name": "Get a list of Steps.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/casemanagement/cases/:caseId/stages/:stageId/steps",
            "params": [
              {
                "name": "caseId",
                "value": "",
                "type": "path",
                "description": "Case identifier."
              },
              {
                "name": "stageId",
                "value": "",
                "type": "path",
                "description": "Stage identifier."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              }
            ]
          },
          "docs": "Get a list of Steps."
        }
      ]
    }
  ],
  "bundled": true
}