Redact a Case | Persona

curl -X DELETE https://api.withpersona.com/api/v1/cases/case-id \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "case_KsFU1Vxv9oK3ztnwQuD7MaJo",
    "attributes": {
      "status": "Approved",
      "name": "KCAS-1",
      "created-at": "2021-03-24T04:59:21.764Z",
      "updated-at": "2021-03-24T04:59:21.764Z",
      "resolved-at": "2021-03-25T04:59:21.764Z",
      "redacted-at": "2021-03-26T04:59:21.764Z",
      "sla-expires-at": "2021-03-26T06:59:21.764Z",
      "creator-id": "case_creator@withpersona.com",
      "creator-type": "user",
      "resolver-id": "case_resolver@withpersona.com",
      "resolver-type": "user",
      "updater-id": "case_updater@withpersona.com",
      "updater-type": "user",
      "tags": [],
      "fields": {},
      "attachments": []
    },
    "relationships": {
      "accounts": {
        "data": [
          {
            "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ",
            "type": "account"
          }
        ]
      },
      "case-comments": {
        "data": [
          {
            "id": "cscm_yd2urRmjaCWcSSxqTSHvUcsn",
            "type": "case-comment"
          }
        ]
      },
      "case-template": {
        "data": {
          "id": "ctmpl_336jV1uVaaY84GAqvG91oiy9",
          "type": "case-template"
        }
      },
      "case-queue": {
        "data": {
          "id": "cqueue_7JRbkcdbx9fTossK98NJvRZcmk1",
          "type": "case-queue"
        }
      },
      "inquiries": {
        "data": [
          {
            "id": "inq_b6UPkf7mNC1qBtLXnfaWyUbY",
            "type": "inquiry"
          }
        ]
      },
      "reports": {
        "data": []
      },
      "verifications": {
        "data": []
      },
      "txns": {
        "data": []
      }
    },
    "type": "case"
  }
}

Permanently redacts a Case and its fields. Case objects must be redacted individually. This action cannot be undone.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

case-idstringRequired

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Response

This endpoint returns a Case object and (optionally) its related objects in included.

dataobject

A Case object

includedlist of objects

Objects that may be returned if specified via the include query parameter in the request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors