Update newsletter template publish settings

Production

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

PUT

/newslettertemplates/{newsletterTemplateId}/publishsettings

Updates the publish settings for a specific newsletter.
This includes newsletter recipients (contacts, contact groups, organizations) and email notification settings (language, details to be included).

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

Publication settings describe who can read a published newsletter or feed.
Options are:

NONE: nobody except the author(s) can access

ORGANIZATION: all users in the current user's organization can access (including users created after publication)

CONTACTS: everyone in the user's contacts can access

SELECTION: an explicit list of contacts, contact groups and organizations can access

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/newslettertemplates//publishsettings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "contactIds": [
        29032713
    ],
    "groupIds": [
        123495
    ],
    "organizationIds": [
        123495
    ],
    "excludeOrganizationGroupIds": [
        123495
    ],
    "notifications": {
        "instant": true,
        "publishLanguage": "EN",
        "includes": {
            "title": true,
            "lead": true,
            "note": true
        }
    },
    "publishType": "ORGANIZATION"
}'

Response Example

200 - Example 1

{
    "contacts": [
        {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "email": "user@example.com",
            "contactType": "INTERNAL"
        }
    ],
    "groups": [
        {
            "contactAmount": 0,
            "id": 0,
            "name": "string"
        }
    ],
    "includedOrganizations": [
        {
            "contactAmount": 0,
            "id": 0,
            "name": "string",
            "type": "INTERNAL"
        }
    ],
    "excludeOrganizationGroups": [
        {
            "id": 0,
            "content": {
                "nl": {
                    "name": "string"
                },
                "fr": {
                    "name": "string"
                },
                "en": {
                    "name": "string"
                }
            }
        }
    ],
    "publishLanguage": "EN",
    "publishType": "ORGANIZATION"
}

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

Fetch newsletter template publish settings

GET user newsletter templates