Skip to main content
PATCH
/
v2
/
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>'
import requests

url = "https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId}"

headers = {"x-api-key": "<api-key>"}

response = requests.patch(url, headers=headers)

print(response.text)
const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};

fetch('https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId}"

req, _ := http.NewRequest("PATCH", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "metadata": {
    "agentId": "<string>"
  },
  "actionsPerformed": {}
}
{
"success": false,
"errorCode": "FORBIDDEN",
"message": "Forbidden - You do not have permission to manage dossiers in this collection"
}
{
"success": false,
"errorCode": "NOT_FOUND",
"message": "Not Found - Dossier not found"
}

Authorizations

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

Dossier updated successfully

metadata
object
required
actionsPerformed
object
required

Actions that were performed on the dossier