Skip to main content
PATCH
/
api
/
v1
/
submission
/
{id}
/
document
/
{filename}
Update Submission Document Details
curl --request PATCH \
  --url https://vision.pingintel.com/api/v1/submission/{id}/document/{filename} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filename": "<string>",
  "document_type": "SOV",
  "is_archived": true
}'
{
  "filename": "<string>",
  "document_type": "SOV",
  "is_archived": true
}

Authorizations

​
Authorization
string
header
required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Path Parameters

​
filename
string
required

The filename of the document to update.

​
id
string
required

The pingid of the submission.

Body

application/json
​
filename
string
Maximum length: 2000
​
document_type
  • SOV - SOV
  • SOV_WORKING_FILE - SOV Working File
  • LOSS_RUN - Loss Run
  • ACORD - ACORD
  • PDF - PDF
  • UNKNOWN - Unknown
  • SOVFIXER_JSON - SOVFixer JSON
  • SOVFIXER_SCRUBBER - SOVFixer Scrubber
  • SOVFIXER_OUTPUT - SOVFixer Output
  • SOVFIXER_AIR_P_CSV - AIR Policy CSV
  • SOVFIXER_AIR_L_CSV - AIR Location CSV
  • SOVFIXER_RMS_P_CSV - RMS Policy CSV
  • SOVFIXER_RMS_L_CSV - RMS Location CSV
  • EML - EML
  • MSG - MSG
  • EMAIL_HTML - Email HTML
  • EMAIL_BODY_HTML - Email Body HTML
  • EMAIL_BODY_TXT - Email Body Text
  • OTHER - Other
  • UFS_CSV - UFS CSV
Available options:
SOV,
SOV_WORKING_FILE,
LOSS_RUN,
ACORD,
PDF,
UNKNOWN,
SOVFIXER_JSON,
SOVFIXER_SCRUBBER,
SOVFIXER_OUTPUT,
SOVFIXER_AIR_P_CSV,
SOVFIXER_AIR_L_CSV,
SOVFIXER_RMS_P_CSV,
SOVFIXER_RMS_L_CSV,
EML,
MSG,
EMAIL_HTML,
EMAIL_BODY_HTML,
EMAIL_BODY_TXT,
OTHER,
UFS_CSV
​
is_archived
boolean

Set to true to archive the document. This is a soft delete, the document is not removed from the database.

Response

​
filename
string
required
Maximum length: 2000
​
document_type
  • SOV - SOV
  • SOV_WORKING_FILE - SOV Working File
  • LOSS_RUN - Loss Run
  • ACORD - ACORD
  • PDF - PDF
  • UNKNOWN - Unknown
  • SOVFIXER_JSON - SOVFixer JSON
  • SOVFIXER_SCRUBBER - SOVFixer Scrubber
  • SOVFIXER_OUTPUT - SOVFixer Output
  • SOVFIXER_AIR_P_CSV - AIR Policy CSV
  • SOVFIXER_AIR_L_CSV - AIR Location CSV
  • SOVFIXER_RMS_P_CSV - RMS Policy CSV
  • SOVFIXER_RMS_L_CSV - RMS Location CSV
  • EML - EML
  • MSG - MSG
  • EMAIL_HTML - Email HTML
  • EMAIL_BODY_HTML - Email Body HTML
  • EMAIL_BODY_TXT - Email Body Text
  • OTHER - Other
  • UFS_CSV - UFS CSV
Available options:
SOV,
SOV_WORKING_FILE,
LOSS_RUN,
ACORD,
PDF,
UNKNOWN,
SOVFIXER_JSON,
SOVFIXER_SCRUBBER,
SOVFIXER_OUTPUT,
SOVFIXER_AIR_P_CSV,
SOVFIXER_AIR_L_CSV,
SOVFIXER_RMS_P_CSV,
SOVFIXER_RMS_L_CSV,
EML,
MSG,
EMAIL_HTML,
EMAIL_BODY_HTML,
EMAIL_BODY_TXT,
OTHER,
UFS_CSV
​
is_archived
boolean

Set to true to archive the document. This is a soft delete, the document is not removed from the database.