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": [
    {
      "context_configuration": [],
      "default_head_tags_disabled": false,
      "use_page_template": false,
      "head_tags": [
        {
          "tag": "<string>",
          "attributes": {},
          "content": "<string>"
        }
      ],
      "filters": {
        "clients": [
          {
            "id": "<string>"
          }
        ],
        "organizations": [
          {
            "id": "<string>"
          }
        ],
        "domains": [
          {
            "id": "<string>"
          }
        ]
      }
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/prompts/rendering"

payload = { "configs": [
        {
            "context_configuration": [],
            "default_head_tags_disabled": False,
            "use_page_template": False,
            "head_tags": [
                {
                    "tag": "<string>",
                    "attributes": {},
                    "content": "<string>"
                }
            ],
            "filters": {
                "clients": [{ "id": "<string>" }],
                "organizations": [{ "id": "<string>" }],
                "domains": [{ "id": "<string>" }]
            }
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configs: [
      {
        context_configuration: [],
        default_head_tags_disabled: false,
        use_page_template: false,
        head_tags: [{tag: '<string>', attributes: {}, content: '<string>'}],
        filters: {
          clients: [{id: '<string>'}],
          organizations: [{id: '<string>'}],
          domains: [{id: '<string>'}]
        }
      }
    ]
  })
};

fetch('https://{tenantDomain}/api/v2/prompts/rendering', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/prompts/rendering",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'configs' => [
        [
                'context_configuration' => [
                                
                ],
                'default_head_tags_disabled' => false,
                'use_page_template' => false,
                'head_tags' => [
                                [
                                                                'tag' => '<string>',
                                                                'attributes' => [
                                                                                                                                
                                                                ],
                                                                'content' => '<string>'
                                ]
                ],
                'filters' => [
                                'clients' => [
                                                                [
                                                                                                                                'id' => '<string>'
                                                                ]
                                ],
                                'organizations' => [
                                                                [
                                                                                                                                'id' => '<string>'
                                                                ]
                                ],
                                'domains' => [
                                                                [
                                                                                                                                'id' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/prompts/rendering"

	payload := strings.NewReader("{\n  \"configs\": [\n    {\n      \"context_configuration\": [],\n      \"default_head_tags_disabled\": false,\n      \"use_page_template\": false,\n      \"head_tags\": [\n        {\n          \"tag\": \"<string>\",\n          \"attributes\": {},\n          \"content\": \"<string>\"\n        }\n      ],\n      \"filters\": {\n        \"clients\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ],\n        \"organizations\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ],\n        \"domains\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ]\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/prompts/rendering")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"configs\": [\n    {\n      \"context_configuration\": [],\n      \"default_head_tags_disabled\": false,\n      \"use_page_template\": false,\n      \"head_tags\": [\n        {\n          \"tag\": \"<string>\",\n          \"attributes\": {},\n          \"content\": \"<string>\"\n        }\n      ],\n      \"filters\": {\n        \"clients\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ],\n        \"organizations\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ],\n        \"domains\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ]\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/prompts/rendering")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"configs\": [\n    {\n      \"context_configuration\": [],\n      \"default_head_tags_disabled\": false,\n      \"use_page_template\": false,\n      \"head_tags\": [\n        {\n          \"tag\": \"<string>\",\n          \"attributes\": {},\n          \"content\": \"<string>\"\n        }\n      ],\n      \"filters\": {\n        \"clients\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ],\n        \"organizations\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ],\n        \"domains\": [\n          {\n            \"id\": \"<string>\"\n          }\n        ]\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "configs": [
    {
      "context_configuration": [],
      "default_head_tags_disabled": false,
      "use_page_template": false,
      "head_tags": [
        {
          "tag": "<string>",
          "attributes": {},
          "content": "<string>"
        }
      ],
      "filters": {
        "clients": [
          {
            "id": "<string>"
          }
        ],
        "organizations": [
          {
            "id": "<string>"
          }
        ],
        "domains": [
          {
            "id": "<string>"
          }
        ]
      }
    }
  ]
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

Bulk update render settings for multiple screens

configs · object[] · 必須

Array of screen configurations to update

Minimum array length: 1

Show child attributes

レスポンス

200

application/json

ACUL settings successfully updated.

configs · object[] · 必須

Array of screen configurations to update

Minimum array length: 1

Show child attributes