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

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

Body

application/json
entityType
enum<string>
required

The target owner's entity type

Available options:
Event,
Exposure,
Quote,
Submission,
Person,
Organization,
Policy,
company
entityId
string<uuid> | null

The target entity's id; null (or omitted) only for entityType: company

folderId
string<uuid> | null

Optional folder of the TARGET owner to place the file in (null/omitted = the target's top level)

Response

Placement added

placementId
string<uuid>

The new placement's id

fileId
string<uuid>

The shared file's id (unchanged)

entityType
string

The target owner's entity type

entityId
string<uuid> | null

The target entity's id

folderId
string<uuid> | null

The folder the new placement sits in