Delete a dossier

Delete a dossier

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

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

DELETE

collections

{collectionId}

dossier

{agentId}

Delete a dossier

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

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

x-api-key

string

header

required

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

collectionId

number | null

required

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

agentId

string

required

Unique identifier for the dossier agent to be managed.

200

application/json

Dossier deleted successfully

The response is of type object.