Update a dossier - Forestreet Documentation

Update a dossier

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

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

PATCH

collections

{collectionId}

dossier

{agentId}

Update a dossier

curl --request PATCH \
  --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

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

agentId

string

required

Unique identifier for the dossier agent to be managed.

Dossier updated successfully

metadata

object

required

Show child attributes

actionsPerformed

object

required

Actions that were performed on the dossier

⌘I