Org Content

Set the welcome messages

PUT/org-content/welcome-message
org-content:writereplace_welcome_messagesDestructiveIdempotent

Sets the welcome message of each audience sent, in the acting user's language, and returns every message stored for that language. Each type may appear once in items; any invalid item returns 422 and nothing is saved. A type already stored is changed in place and a type not yet stored is added; types you leave out are kept. Messages are HTML and are stored as sent, up to 65535 bytes each (422 above that); an empty string or null clears a message and is read back empty. Needs permission to change the organisation. An Opportunity Provider shows its creator's messages and cannot set its own, returning 403 forbidden. dry_run shows the result without saving it. Emits welcome_message.updated once, with the changed types in changed_fields, and only when the text of a message changed (retiring duplicate stored rows alone does not count); no email. Sending the earlier messages undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · WelcomeMessageReplace

  • itemsobject[]Required#

    The messages to set, one per audience at most.

{
  "items": [
    {
      "type": "User",
      "message": "<p>Welcome, {{forename}}.</p>"
    },
    {
      "type": "Internal User",
      "message": "<p>Welcome to the team, {{title}} {{surname}}.</p>"
    }
  ]
}

Responses

200

The messages stored for the acting user's language.

WelcomeMessageSetEnvelope
{
  "data": {
    "items": [
      {
        "type": "User",
        "message": "string",
        "updated_at": "2026-06-12T10:00:00+00:00"
      }
    ]
  }
}
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
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 -X PUT https://your-org-domain/kong/core/api/v2/org-content/welcome-message\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "items": [
    {
      "type": "User",
      "message": "<p>Welcome, {{forename}}.</p>"
    },
    {
      "type": "Internal User",
      "message": "<p>Welcome to the team, {{title}} {{surname}}.</p>"
    }
  ]
}'