Create document object

Production

POST

/newsrooms/{newsroomId}/documents

Adds a new document object in a newsroom.
A document object must be one of 3 available types:

FILE: the file attribute must link to a previously uploaded binary file, see POST /media/files

EMBED: the embed attribute must contain an embed url (e.g. to a Youtube video)

FOLDER: the thumbnail attribute may be filled in for a previously uploaded custom folder thumbnail image, see POST /media/images

The parentId attribute can be used to create hierarchy. It must always refer to a folder.
When its value is null, the document will be added to the newsroom's root folder.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Item created successfully

Body

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/newsrooms//documents' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "FILE",
    "language": "NL",
    "parentId": "string",
    "name": "string",
    "thumbnail": {
        "id": 0
    },
    "embed": {
        "name": "string",
        "url": "string"
    },
    "file": {
        "id": 0
    }
}'

Response Example

200 - Example 1

{
    "id": 0,
    "type": "FILE",
    "language": "NL",
    "parentId": 0,
    "name": "string",
    "thumbnail": {
        "id": 0,
        "url": "http://example.com"
    },
    "embed": {
        "name": "string",
        "url": "string"
    },
    "meta": {
        "numberOfItems": 0
    },
    "file": {
        "id": 0,
        "url": "http://example.com",
        "assetType": "BELGA_IMAGE",
        "belgaImageUuid": "string",
        "fileName": "string",
        "fileSize": 0,
        "fileType": "DOCX",
        "cropzone": {
            "x": 0,
            "y": 0,
            "width": 0,
            "height": 0
        }
    },
    "updateDate": "2019-08-24T14:15:22.123Z"
}

Modified at 2025-11-12 15:06:51

PUT Newsroom DNS settings

Get document objects