UpdateMetadata

This operation enables the relevant organisation to update the document as sensitive document and/or assessment document and/or published document.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

The relevant organisation name to indicate where the request is originated from.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

Information request object

Array of objects (DocumentsInfo)
updatedByEmail
string <= 256 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}