Org Content

Get the welcome message

GET/org-content/welcome-message

Returns the welcome message for the caller's audience in the caller's language: Internal User for a user of the token organisation, Entrepreneur for a user of an Opportunity Provider, and User for anyone else. An Opportunity Provider shows the message of the organisation that created it. Language is the one on the caller's contact, with no fallback to another. A user who can change the organisation can read another audience with filter[type]; any other reader sending it returns 403 missing_permission. No message for that audience and language returns 404.

variables is resolved (the default), which replaces {{title}}, {{forename}} and {{surname}} with the caller's own, HTML-escaped and in a single pass so a name that looks like a placeholder stays literal, or raw, which returns the stored text. The message is HTML and is returned as stored. Changes nothing. Use PUT /org-content/welcome-message to set the messages.

Query parameters

  • variablesstring#

    resolved (default) replaces {{title}}, {{forename}} and {{surname}} with the caller's own; raw returns the stored text.

    One of: resolved, rawDefault: "resolved"
  • filter[type]string#

    Reads the message of another audience instead of the caller's: User, Internal User or Entrepreneur. Needs permission to change the organisation.

    One of: User, Internal User, Entrepreneur

Responses

200

The welcome message.

WelcomeMessageEnvelope
{
  "data": {
    "type": "Internal User",
    "message": "<p>Welcome, Ada.</p>",
    "variables": "resolved",
    "updated_at": "2026-06-15T10:30:00Z"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/org-content/welcome-message\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"