Update render settings for multiple screens

Learn more about configuring render settings for advanced customization.

PATCH https://{tenantDomain}/api/v2/prompts/rendering

Update render settings for multiple screens

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/prompts/rendering \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configs": [
    {
      "prompt": "login",
      "screen": "login",
      "rendering_mode": "advanced",
      "context_configuration": [
        "branding.settings"
      ],
      "default_head_tags_disabled": false,
      "use_page_template": false,
      "head_tags": [
        {
          "tag": "<string>",
          "attributes": {},
          "content": "<string>"
        }
      ],
      "filters": {
        "match_type": "includes_any",
        "clients": [
          {
            "id": "<string>"
          }
        ],
        "organizations": [
          {
            "id": "<string>"
          }
        ],
        "domains": [
          {
            "id": "<string>"
          }
        ]
      }
    }
  ]
}
'

200

{
  "configs": [
    {
      "prompt": "login",
      "screen": "login",
      "rendering_mode": "advanced",
      "context_configuration": [
        "branding.settings"
      ],
      "default_head_tags_disabled": false,
      "use_page_template": false,
      "head_tags": [
        {
          "tag": "<string>",
          "attributes": {},
          "content": "<string>"
        }
      ],
      "filters": {
        "match_type": "includes_any",
        "clients": [
          {
            "id": "<string>"
          }
        ],
        "organizations": [
          {
            "id": "<string>"
          }
        ],
        "domains": [
          {
            "id": "<string>"
          }
        ]
      }
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/jsonapplication/x-www-form-urlencoded

Bulk update render settings for multiple screens

configs · object[] · required

Array of screen configurations to update

Minimum array length: 1

Show child attributes

Response

200

application/json

ACUL settings successfully updated.

configs · object[] · required

Array of screen configurations to update

Minimum array length: 1

Show child attributes