Skip to main content
PATCH
/
api
/
v1
/
external
/
companies
/
{companyId}
/
files
/
{fileId}
/
placements
/
{placementId}
curl --request PATCH \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/files/{fileId}/placements/{placementId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folderId": "550e8400-e29b-41d4-a716-446655440001"
}
'
{
  "placementId": "550e8400-e29b-41d4-a716-446655440032",
  "fileId": "550e8400-e29b-41d4-a716-446655440020",
  "entityType": "Submission",
  "entityId": "550e8400-e29b-41d4-a716-446655440011",
  "folderId": "550e8400-e29b-41d4-a716-446655440001",
  "category": "Loss Runs"
}

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

Body

application/json
folderId
string<uuid> | null

New folder id (must belong to the placement's owner), or null for the owner's top level

category
string | null

Free-text category label (max 255 characters), or null to clear it

Maximum string length: 255

Response

Placement updated

placementId
string<uuid>

Id of the updated placement

fileId
string<uuid>

The file the placement belongs to

entityType
string

The placement owner's entity type

entityId
string<uuid> | null

The placement owner's entity id (null for the company level)

folderId
string<uuid> | null

The folder the placement now sits in

category
string | null

The placement's category after the update