Set Link settings

Replaces the entire link list at the requested scope. This is a full replacement, not a merge — omitted links are removed.

To add a link, include the full list with the new link appended. To remove a link, include the full list without it.

Header Parameters

Connect-Protocol-Version*Connect-Protocol-Version

Define the version of the Connect protocol

Value in1

Connect-Timeout-Ms?Connect-Timeout-Ms

Define the timeout, in ms

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ctx?|

ctx specifies the context for which the link settings should be set. This can be the instance, organization,... according to the hierarchical model of the settings.

links?array<>

link is the collection of links to which the setting should be set.

Validation:

Each well-known type (TERMS_OF_SERVICE, PRIVACY_POLICY, etc.) may appear at most once.
CUSTOM links may appear multiple times.
url must be a valid absolute URL or a mailto address.
translation_key is required when type is CUSTOM.
translation_key must be empty for well-known types.

Response Body

`application/json`

curl -X POST "https://loading/zitadel.settings.v2.SettingsService/SetLinkSettings" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'

{
  "changeDate": "2023-01-15T01:30:15.01Z",
  "settings": {
    "links": [
      {
        "type": "LINK_TYPE_UNSPECIFIED",
        "url": "string",
        "translationKey": "string",
        "target": "LINK_TARGET_UNSPECIFIED"
      }
    ]
  }
}

{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`