Edit or replace a working document reference
curl --request PATCH \
--url https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduleSeqNo": 1073741823,
"context": "<string>",
"attachments": [
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactName": "<string>"
}
]
}
'import requests
url = "https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}"
payload = {
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduleSeqNo": 1073741823,
"context": "<string>",
"attachments": [
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactName": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
artifactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scheduleSeqNo: 1073741823,
context: '<string>',
attachments: [{artifactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', artifactName: '<string>'}]
})
};
fetch('https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}', 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://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'artifactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scheduleSeqNo' => 1073741823,
'context' => '<string>',
'attachments' => [
[
'artifactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'artifactName' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}"
payload := strings.NewReader("{\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduleSeqNo\": 1073741823,\n \"context\": \"<string>\",\n \"attachments\": [\n {\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifactName\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduleSeqNo\": 1073741823,\n \"context\": \"<string>\",\n \"attachments\": [\n {\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifactName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduleSeqNo\": 1073741823,\n \"context\": \"<string>\",\n \"attachments\": [\n {\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifactName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactVersionId": "<string>",
"scheduleType": "form",
"scheduleSeqNo": 1,
"context": "<string>",
"attachments": [
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactVersionId": "<string>",
"artifactName": "<string>",
"artifactVersionNumber": 1
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}Managed Filings
Edit or replace a working document reference
Set supplied fields with last-write-wins semantics. Send both schedule fields as null to unassign an item. Replacing artifactId changes the working reference only. The item must belong to this filing; it cannot be moved. Retained submission versions are unchanged. Requires filing edit permission.
PATCH
/
managed-filings
/
{filingId}
/
items
/
{itemId}
Edit or replace a working document reference
curl --request PATCH \
--url https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduleSeqNo": 1073741823,
"context": "<string>",
"attachments": [
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactName": "<string>"
}
]
}
'import requests
url = "https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}"
payload = {
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduleSeqNo": 1073741823,
"context": "<string>",
"attachments": [
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactName": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
artifactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scheduleSeqNo: 1073741823,
context: '<string>',
attachments: [{artifactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', artifactName: '<string>'}]
})
};
fetch('https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}', 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://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'artifactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scheduleSeqNo' => 1073741823,
'context' => '<string>',
'attachments' => [
[
'artifactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'artifactName' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}"
payload := strings.NewReader("{\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduleSeqNo\": 1073741823,\n \"context\": \"<string>\",\n \"attachments\": [\n {\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifactName\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduleSeqNo\": 1073741823,\n \"context\": \"<string>\",\n \"attachments\": [\n {\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifactName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://canary.effectiveai.app/api/v2/managed-filings/{filingId}/items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduleSeqNo\": 1073741823,\n \"context\": \"<string>\",\n \"attachments\": [\n {\n \"artifactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifactName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactVersionId": "<string>",
"scheduleType": "form",
"scheduleSeqNo": 1,
"context": "<string>",
"attachments": [
{
"artifactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactVersionId": "<string>",
"artifactName": "<string>",
"artifactVersionNumber": 1
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Body
application/json
Available options:
form, rate, rule, supporting_document, null Required range:
0 < x <= 2147483647Required string length:
1 - 20000Related working files follow current content. Version pinning happens when recording a submission.
Maximum array length:
100Show child attributes
Show child attributes
Response
Updated item.
Available options:
form, rate, rule, supporting_document, null Required range:
x > 0Show child attributes
Show child attributes