COcompanies-house
events

Update the metadata of an attached file

post/events/submissions/{submission-id}/files/{file-id}

Request

  • Base URL
    /efs-submissions-api (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

submission-idstring required

Unique submission selector

file-idstring UUID required

Unique file identifier

Request body

converted_file_idstring

Converted file identifier

conversion_status'CONVERTED' | 'FAILED'
number_of_pagesnumber

Number of pages in the converted file

Example request

{
  "converted_file_id": "654321",
  "number_of_pages": 1234
}

Response

The request completed successfully

Changes

No recorded changes to this operation across all 11 revisions of this API.