Remove Persona objects from a Case

POST

https://api.withpersona.com/api/v1/cases/:case-id/remove-objects

POST

/api/v1/cases/:case-id/remove-objects

$ curl -X POST https://api.withpersona.com/api/v1/cases/case-id/remove-objects \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "meta": {
>     "object-ids": [
>       "inq_eGK41TM6GjcZgdcoox7x8Hh0",
>       "rep_PN3xspEwWCWWRp1eGpedaSNj"
>     ]
>   }
> }'

1 {
2   "data": {
3     "id": "case_3maVhdLzdGftRZCvxfqazVL1",
4     "attributes": {
5       "status": "resolved",
6       "name": "WATC-16",
7       "resolution": "Escalated",
8       "created-at": "2021-06-30T20:37:18.678Z",
9       "updated-at": "2021-08-26T18:24:19.695Z",
10       "resolved-at": "2021-08-26T18:24:19.000Z",
11       "creator-id": "wfl_yKynZZiuPz1R5qm9JFyBnnLB",
12       "creator-type": "workflow-run",
13       "tags": [],
14       "fields": {},
15       "attachments": []
16     },
17     "relationships": {
18       "accounts": {
19         "data": []
20       },
21       "case-comments": {
22         "data": []
23       },
24       "case-template": {
25         "data": {
26           "id": "ctmpl_6HheND7s14a2o7fg33iHqhg7",
27           "type": "case-template"
28         }
29       },
30       "case-queue": {
31         "data": {
32           "id": "cqueue_7JRbkcdbx9fTossK98NJvRZcmk1",
33           "type": "case-queue"
34         }
35       },
36       "inquiries": {
37         "data": []
38       },
39       "reports": {
40         "data": []
41       },
42       "verifications": {
43         "data": []
44       },
45       "txns": {
46         "data": []
47       }
48     },
49     "type": "case"
50   }
51 }

Removes Persona objects (such as inquiries, accounts, or reports) from a Case. This operation is idempotent — removing an object that is not attached succeeds without modifying the case.

Authentication

AuthorizationBearer

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

Path parameters

case-idstringRequired

ID of the case to update

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.

Request

This endpoint expects an object.

metaobjectOptional

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