Delete a dossier

Remove a dossier from the specified collection

DELETE /v2/collections/{collectionId}/dossier/{agentId}

Delete a dossier

cURL

curl --request DELETE \
  --url https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId} \
  --header 'x-api-key: <api-key>'

200

{
  "metadata": {
    "agentId": "<string>"
  },
  "actionsPerformed": {}
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

x-api-key · string · header · required

Pass a static API key for every request, provided by your customer support.

Path Parameters

collectionId · number | null

ID of the collection containing the dossier agent to be managed.

agentId · string · required

Unique identifier for the dossier agent to be managed.

Response

200

application/json

Dossier deleted successfully

metadata · object · required

Show child attributes

actionsPerformed · object · required

Actions that were performed on the dossier