Remove File Placement

curl --request DELETE \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}"

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

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

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}', 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://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}")

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

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

response = http.request(request)
puts response.read_body

{
  "id": "550e8400-e29b-41d4-a716-446655440032",
  "fileId": "550e8400-e29b-41d4-a716-446655440020",
  "fileDeleted": false
}

Placements

Remove File Placement

Removes ONE placement of a file — “remove from this entity”, not “delete the file”. While other placements remain the file (and its stored content) is untouched and stays available everywhere else it appears. Removing the file’s LAST placement deletes the file itself and reclaims its stored objects, exactly like Delete File — which remains the way to delete a file from everywhere at once.

Required permission: company.file:delete

DELETE

api

companies

{companyId}

files

{fileId}

placements

{placementId}

Remove File Placement

curl --request DELETE \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}"

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

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

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}', 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://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}")

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

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

response = http.request(request)
puts response.read_body

{
  "id": "550e8400-e29b-41d4-a716-446655440032",
  "fileId": "550e8400-e29b-41d4-a716-446655440020",
  "fileDeleted": false
}

Authorizations

Authorization

string

header

required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId

string<uuid>

required

Company identifier

fileId

string<uuid>

required

File identifier

placementId

string<uuid>

required

Placement identifier

Response

Placement removed

string<uuid>

Id of the removed placement

fileId

string<uuid>

The file the placement belonged to

fileDeleted

boolean

True when the removed placement was the file's last — the file itself was deleted and its storage reclaimed

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Remove File Placement

Authorizations

Path Parameters

Response