Skip to main content
PATCH
Resolve cases for an entity

Authorizations

apiKey
string
header
required

API key issued by FrankieOne. This will rotate regularly.

Headers

X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

Path Parameters

entityId
string
required

Unique identifier of a FrankieOne entity The unique identifier for a FrankieOne entity construct

Example:

"98ded7ac-2457-4bde-b27c-fcee05301262"

Body

application/json
update
object

Describes the update to a case status check, either via a comment appended to the case, a status update or an assignment of the case to another user

filter
object

Response

Response from the PATCH /entity/{entityId}/cases endpoint

total
integer
required

Total of number of items that were found to be actioned by bulk update request

successful
object
required

Represents the result of a bulk update action

failed
object
required

Represents the result of a bulk update action