PUT newsletter

Production

https://api.belga.press/belgapress/api

PUT

/newsletters/{newsletterId}

Updates an existing newsletter

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://sso.ssl.belga.be/auth/realms/belga/protocol/openid-connect/auth

Token URL: https://sso.ssl.belga.be/auth/realms/belga/protocol/openid-connect/token

Scopes:

offline_access-Offline access

openid-OpenID

profile-Profile

email-Email

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.belga.press/belgapress/api/newsletters/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "brandId": 0,
    "collaboration": {
        "editorIds": [
            0
        ],
        "ownerIds": [
            0
        ],
        "type": "PRIVATE"
    },
    "description": "string",
    "name": "string",
    "originalId": 0,
    "publishDate": "2019-08-24T14:15:22.123Z",
    "status": "DRAFT",
    "type": "NEWSLETTER"
}'

Response Example

200 - Example 1

{
    "brand": {
        "accentColor": "string",
        "coverImage": {
            "id": 0,
            "url": "http://example.com"
        },
        "description": "string",
        "id": 0,
        "logo": {
            "id": 0,
            "url": "http://example.com"
        },
        "name": "string",
        "updateDate": "2019-08-24T14:15:22.123Z"
    },
    "collaboration": {
        "type": "PRIVATE",
        "owners": [
            {
                "userId": 0,
                "firstName": "string",
                "lastName": "string",
                "email": "user@example.com",
                "organizationName": "string"
            }
        ],
        "editors": [
            {
                "userId": 0,
                "firstName": "string",
                "lastName": "string",
                "email": "user@example.com",
                "organizationName": "string"
            }
        ]
    },
    "noCoverImage": true,
    "coverImage": "http://example.com",
    "createDate": "2019-08-24T14:15:22.123Z",
    "description": "string",
    "draftId": 0,
    "id": 0,
    "items": [
        {
            "fields": {
                "count": 0,
                "dateRangeType": "TODAY",
                "labelIds": [
                    0
                ],
                "order": "MANUAL",
                "orderArray": [
                    "string"
                ]
            },
            "id": 0,
            "note": "string",
            "order": 0,
            "title": "string",
            "type": "HEADING"
        }
    ],
    "name": "string",
    "organizationName": "string",
    "originalId": 0,
    "publishDate": "2019-08-24T14:15:22.123Z",
    "recurringId": 0,
    "status": "DRAFT",
    "templateId": 0,
    "type": "NEWSLETTER",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2025-11-05 16:04:27

PATCH newsletter

DELETE newsletter collaborator