ページ更新

ページ更新

curl --request PATCH \
  --url https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "html_source": "<string>",
  "page_title": "<string>",
  "elements": [
    {}
  ],
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_og_image": "<string>",
  "is_no_index": true,
  "pc_width": 1010,
  "background_color": "<string>",
  "background_image_src": "<string>",
  "background_image_style": "<string>",
  "js_head": "<string>",
  "js_body_top": "<string>",
  "js_body": "<string>",
  "css": "<string>",
  "use_popup": true,
  "popup_width": 800,
  "popup_background_color": "<string>",
  "popup_elements": [
    {}
  ],
  "is_high_speed_mode": true
}
'

import requests

url = "https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}"

payload = {
    "title": "<string>",
    "html_source": "<string>",
    "page_title": "<string>",
    "elements": [{}],
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_og_image": "<string>",
    "is_no_index": True,
    "pc_width": 1010,
    "background_color": "<string>",
    "background_image_src": "<string>",
    "background_image_style": "<string>",
    "js_head": "<string>",
    "js_body_top": "<string>",
    "js_body": "<string>",
    "css": "<string>",
    "use_popup": True,
    "popup_width": 800,
    "popup_background_color": "<string>",
    "popup_elements": [{}],
    "is_high_speed_mode": True
}
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({
    title: '<string>',
    html_source: '<string>',
    page_title: '<string>',
    elements: [{}],
    meta_title: '<string>',
    meta_description: '<string>',
    meta_og_image: '<string>',
    is_no_index: true,
    pc_width: 1010,
    background_color: '<string>',
    background_image_src: '<string>',
    background_image_style: '<string>',
    js_head: '<string>',
    js_body_top: '<string>',
    js_body: '<string>',
    css: '<string>',
    use_popup: true,
    popup_width: 800,
    popup_background_color: '<string>',
    popup_elements: [{}],
    is_high_speed_mode: true
  })
};

fetch('https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}', 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://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}",
  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([
    'title' => '<string>',
    'html_source' => '<string>',
    'page_title' => '<string>',
    'elements' => [
        [
                
        ]
    ],
    'meta_title' => '<string>',
    'meta_description' => '<string>',
    'meta_og_image' => '<string>',
    'is_no_index' => true,
    'pc_width' => 1010,
    'background_color' => '<string>',
    'background_image_src' => '<string>',
    'background_image_style' => '<string>',
    'js_head' => '<string>',
    'js_body_top' => '<string>',
    'js_body' => '<string>',
    'css' => '<string>',
    'use_popup' => true,
    'popup_width' => 800,
    'popup_background_color' => '<string>',
    'popup_elements' => [
        [
                
        ]
    ],
    'is_high_speed_mode' => true
  ]),
  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://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"html_source\": \"<string>\",\n  \"page_title\": \"<string>\",\n  \"elements\": [\n    {}\n  ],\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_og_image\": \"<string>\",\n  \"is_no_index\": true,\n  \"pc_width\": 1010,\n  \"background_color\": \"<string>\",\n  \"background_image_src\": \"<string>\",\n  \"background_image_style\": \"<string>\",\n  \"js_head\": \"<string>\",\n  \"js_body_top\": \"<string>\",\n  \"js_body\": \"<string>\",\n  \"css\": \"<string>\",\n  \"use_popup\": true,\n  \"popup_width\": 800,\n  \"popup_background_color\": \"<string>\",\n  \"popup_elements\": [\n    {}\n  ],\n  \"is_high_speed_mode\": true\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://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"html_source\": \"<string>\",\n  \"page_title\": \"<string>\",\n  \"elements\": [\n    {}\n  ],\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_og_image\": \"<string>\",\n  \"is_no_index\": true,\n  \"pc_width\": 1010,\n  \"background_color\": \"<string>\",\n  \"background_image_src\": \"<string>\",\n  \"background_image_style\": \"<string>\",\n  \"js_head\": \"<string>\",\n  \"js_body_top\": \"<string>\",\n  \"js_body\": \"<string>\",\n  \"css\": \"<string>\",\n  \"use_popup\": true,\n  \"popup_width\": 800,\n  \"popup_background_color\": \"<string>\",\n  \"popup_elements\": [\n    {}\n  ],\n  \"is_high_speed_mode\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}")

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  \"title\": \"<string>\",\n  \"html_source\": \"<string>\",\n  \"page_title\": \"<string>\",\n  \"elements\": [\n    {}\n  ],\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_og_image\": \"<string>\",\n  \"is_no_index\": true,\n  \"pc_width\": 1010,\n  \"background_color\": \"<string>\",\n  \"background_image_src\": \"<string>\",\n  \"background_image_style\": \"<string>\",\n  \"js_head\": \"<string>\",\n  \"js_body_top\": \"<string>\",\n  \"js_body\": \"<string>\",\n  \"css\": \"<string>\",\n  \"use_popup\": true,\n  \"popup_width\": 800,\n  \"popup_background_color\": \"<string>\",\n  \"popup_elements\": [\n    {}\n  ],\n  \"is_high_speed_mode\": true\n}"

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

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "page_title": "<string>",
    "html_source": "<string>",
    "elements": [
      {}
    ],
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_og_image": "<string>",
    "is_no_index": true,
    "pc_width": 123,
    "background_color": "<string>",
    "background_image_src": "<string>",
    "background_image_style": "<string>",
    "js_head": "<string>",
    "js_body_top": "<string>",
    "js_body": "<string>",
    "css": "<string>",
    "use_popup": true,
    "popup_width": 123,
    "popup_background_color": "<string>",
    "popup_elements": [
      {}
    ],
    "is_high_speed_mode": true,
    "order": 123,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "step_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "認証に失敗しました"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "アクセス権限がありません"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "リソースが見つかりません"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "バリデーションエラーが発生しました"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "リクエスト上限を超えました。しばらく時間を空けて再試行してください"
  }
}

ページ更新

curl --request PATCH \
  --url https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "html_source": "<string>",
  "page_title": "<string>",
  "elements": [
    {}
  ],
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_og_image": "<string>",
  "is_no_index": true,
  "pc_width": 1010,
  "background_color": "<string>",
  "background_image_src": "<string>",
  "background_image_style": "<string>",
  "js_head": "<string>",
  "js_body_top": "<string>",
  "js_body": "<string>",
  "css": "<string>",
  "use_popup": true,
  "popup_width": 800,
  "popup_background_color": "<string>",
  "popup_elements": [
    {}
  ],
  "is_high_speed_mode": true
}
'

import requests

url = "https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}"

payload = {
    "title": "<string>",
    "html_source": "<string>",
    "page_title": "<string>",
    "elements": [{}],
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_og_image": "<string>",
    "is_no_index": True,
    "pc_width": 1010,
    "background_color": "<string>",
    "background_image_src": "<string>",
    "background_image_style": "<string>",
    "js_head": "<string>",
    "js_body_top": "<string>",
    "js_body": "<string>",
    "css": "<string>",
    "use_popup": True,
    "popup_width": 800,
    "popup_background_color": "<string>",
    "popup_elements": [{}],
    "is_high_speed_mode": True
}
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({
    title: '<string>',
    html_source: '<string>',
    page_title: '<string>',
    elements: [{}],
    meta_title: '<string>',
    meta_description: '<string>',
    meta_og_image: '<string>',
    is_no_index: true,
    pc_width: 1010,
    background_color: '<string>',
    background_image_src: '<string>',
    background_image_style: '<string>',
    js_head: '<string>',
    js_body_top: '<string>',
    js_body: '<string>',
    css: '<string>',
    use_popup: true,
    popup_width: 800,
    popup_background_color: '<string>',
    popup_elements: [{}],
    is_high_speed_mode: true
  })
};

fetch('https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}', 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://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}",
  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([
    'title' => '<string>',
    'html_source' => '<string>',
    'page_title' => '<string>',
    'elements' => [
        [
                
        ]
    ],
    'meta_title' => '<string>',
    'meta_description' => '<string>',
    'meta_og_image' => '<string>',
    'is_no_index' => true,
    'pc_width' => 1010,
    'background_color' => '<string>',
    'background_image_src' => '<string>',
    'background_image_style' => '<string>',
    'js_head' => '<string>',
    'js_body_top' => '<string>',
    'js_body' => '<string>',
    'css' => '<string>',
    'use_popup' => true,
    'popup_width' => 800,
    'popup_background_color' => '<string>',
    'popup_elements' => [
        [
                
        ]
    ],
    'is_high_speed_mode' => true
  ]),
  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://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"html_source\": \"<string>\",\n  \"page_title\": \"<string>\",\n  \"elements\": [\n    {}\n  ],\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_og_image\": \"<string>\",\n  \"is_no_index\": true,\n  \"pc_width\": 1010,\n  \"background_color\": \"<string>\",\n  \"background_image_src\": \"<string>\",\n  \"background_image_style\": \"<string>\",\n  \"js_head\": \"<string>\",\n  \"js_body_top\": \"<string>\",\n  \"js_body\": \"<string>\",\n  \"css\": \"<string>\",\n  \"use_popup\": true,\n  \"popup_width\": 800,\n  \"popup_background_color\": \"<string>\",\n  \"popup_elements\": [\n    {}\n  ],\n  \"is_high_speed_mode\": true\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://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"html_source\": \"<string>\",\n  \"page_title\": \"<string>\",\n  \"elements\": [\n    {}\n  ],\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_og_image\": \"<string>\",\n  \"is_no_index\": true,\n  \"pc_width\": 1010,\n  \"background_color\": \"<string>\",\n  \"background_image_src\": \"<string>\",\n  \"background_image_style\": \"<string>\",\n  \"js_head\": \"<string>\",\n  \"js_body_top\": \"<string>\",\n  \"js_body\": \"<string>\",\n  \"css\": \"<string>\",\n  \"use_popup\": true,\n  \"popup_width\": 800,\n  \"popup_background_color\": \"<string>\",\n  \"popup_elements\": [\n    {}\n  ],\n  \"is_high_speed_mode\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}")

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  \"title\": \"<string>\",\n  \"html_source\": \"<string>\",\n  \"page_title\": \"<string>\",\n  \"elements\": [\n    {}\n  ],\n  \"meta_title\": \"<string>\",\n  \"meta_description\": \"<string>\",\n  \"meta_og_image\": \"<string>\",\n  \"is_no_index\": true,\n  \"pc_width\": 1010,\n  \"background_color\": \"<string>\",\n  \"background_image_src\": \"<string>\",\n  \"background_image_style\": \"<string>\",\n  \"js_head\": \"<string>\",\n  \"js_body_top\": \"<string>\",\n  \"js_body\": \"<string>\",\n  \"css\": \"<string>\",\n  \"use_popup\": true,\n  \"popup_width\": 800,\n  \"popup_background_color\": \"<string>\",\n  \"popup_elements\": [\n    {}\n  ],\n  \"is_high_speed_mode\": true\n}"

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

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "page_title": "<string>",
    "html_source": "<string>",
    "elements": [
      {}
    ],
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_og_image": "<string>",
    "is_no_index": true,
    "pc_width": 123,
    "background_color": "<string>",
    "background_image_src": "<string>",
    "background_image_style": "<string>",
    "js_head": "<string>",
    "js_body_top": "<string>",
    "js_body": "<string>",
    "css": "<string>",
    "use_popup": true,
    "popup_width": 123,
    "popup_background_color": "<string>",
    "popup_elements": [
      {}
    ],
    "is_high_speed_mode": true,
    "order": 123,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "step_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "認証に失敗しました"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "アクセス権限がありません"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "リソースが見つかりません"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "バリデーションエラーが発生しました"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "リクエスト上限を超えました。しばらく時間を空けて再試行してください"
  }
}

PATCH（後方互換として PUT も利用可）

https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}

指定したフィールドのみ更新する部分更新です。リクエストに含めなかったフィールドは既存の値が維持されます。content_type は作成後に変更できません。

Authorizations

Authorization

string

header

required

APIキーをBearerトークンとして指定

Path Parameters

funnel_id

string

required

ファネルID

step_id

string

required

ステップID

page_id

string

required

ページID

Body

application/json

title

string

管理名称

Maximum string length: 255

content_type

enum<string>

コンテンツタイプ（作成後に変更不可。異なる値を指定すると400エラー）

Available options:

elements,

raw_html

html_source

string

HTML文字列（content_type=raw_html時に必須、最大4MB）

page_title

string

ページタイトル（content_type=elementsのみ）

elements

object[]

要素の配列（content_type=elements時）。GETで取得した構造をベースに変更箇所のみ修正して送信

meta_title

string

タイトル

Maximum string length: 255

meta_description

string

説明

Maximum string length: 500

meta_og_image

string<uri>

OG画像(og:image)URL

is_no_index

boolean

検索エンジン設定

pc_width

integer

ページ幅(PC)

Required range: 100 <= x <= 1920

border_type

enum<string>

ページ枠(PC)

Available options:

shadow,

border,

none

swipe_type

enum<string>

ページスワイプ

Available options:

none,

vertical,

horizontal

background_color

string

ページ全体の背景色（#RRGGBB 形式を推奨）

Maximum string length: 20

background_image_src

string

背景画像URL

Maximum string length: 2048

background_image_style

string

背景画像スタイル（cover_fixed / w100 / h100 / no_repeat / repeat を推奨）

Maximum string length: 30

js_head

string

head内JavaScript

js_body_top

string

body直後JavaScript

js_body

string

body末尾JavaScript

css

string

カスタムCSS

ポップアップ使用

イグジットポップアップ

Available options:

exit,

exit_all

ポップアップ幅

Required range: 600 <= x <= 1000

ポップアップ背景色（#RRGGBB 形式を推奨）

Maximum string length: 20

表示位置

Available options:

top,

centered

ポップアップ要素の配列

is_high_speed_mode

boolean

高速表示モード

Response

更新されたページ

data

object

Show child attributes

APIリファレンス

ファネル

配信

メディア

要素・タイプリファレンス

Authorizations

Path Parameters

Body

Response