PUT /api/v2/server-side-api/paywalls/{paywall_id}/

Cập nhật paywall

Cập nhật Remote Config của một paywall cụ thể. Endpoint này cho phép bạn chỉnh sửa các giá trị Remote Config giúp tùy chỉnh giao diện và hành vi của paywall.

Quan trọng: Nếu bạn cập nhật Remote Config, nó sẽ ghi đè toàn bộ các Remote Config hiện có! Nếu bạn cần giữ lại các Remote Config hiện có, trước tiên hãy lấy paywall. Sau đó, sao chép remote_configs từ đó và chỉnh sửa các đối tượng bạn cần trong yêu cầu cập nhật.

Path parameters

paywall_idstring · uuidrequired

Định danh duy nhất của paywall cần cập nhật

Request body

Phải cung cấp ít nhất một trường

remote_configsarray of objectrequired

Mảng các đối tượng RemoteConfig cần cập nhật

localestringrequired

Ngôn ngữ cho Remote Config (ví dụ: "en", "es", "fr")

datastringrequired

Chuỗi JSON chứa dữ liệu Remote Config

Responses

Paywall được cập nhật thành công

Schema

titlestringrequired

Tên của paywall, được xác định trong Adapty Dashboard của bạn

paywall_idstringrequired

Định danh duy nhất của paywall

use_paywall_builderbooleanrequired

Liệu paywall có sử dụng Paywall Builder hay không

use_paywall_builder_legacybooleanrequired

Liệu paywall có sử dụng Paywall Builder kế thừa hay không

updated_atstringrequired

Dấu thời gian khi paywall được cập nhật lần cuối

created_atstringrequired

Dấu thời gian khi paywall được tạo

statestringrequired

Trạng thái hiện tại của paywall

One of: "draft", "live", "inactive", "archived"

is_deletedbooleanrequired

Liệu paywall có được đánh dấu là đã xóa hay không

web_purchase_urlstring

URL cho giao dịch mua trên web, nếu có

productsarray of objectrequired

Mảng các đối tượng sản phẩm chứa thông tin sản phẩm

product_idstringrequired

Định danh duy nhất của sản phẩm

titlestringrequired

Tiêu đề của sản phẩm

product_setstringrequired

Danh mục bộ sản phẩm

One of: "weekly", "monthly", "trimonthly", "semiannual", "annual", "lifetime", "uncategorised", "nonsubscriptions", "two_months", "consumable"

offerobjectrequired

product_offer_idstringrequired

Định danh duy nhất của ưu đãi sản phẩm

titlestringrequired

Tiêu đề của ưu đãi

remote_configsarray of object

Mảng các đối tượng RemoteConfig với ngôn ngữ và dữ liệu

localestringrequired

Ngôn ngữ cho Remote Config

datastringrequired

Chuỗi JSON chứa dữ liệu Remote Config

main_screenshotobject

Đối tượng ảnh chụp màn hình chính với image_id và url

image_idintegerrequired

Định danh duy nhất của hình ảnh

urlstringrequired

URL của hình ảnh

Example

{
  "title": "Premium Subscription",
  "paywall_id": "fd891d4f-5906-45b9-97c1-13cc3dc665df",
  "use_paywall_builder": true,
  "use_paywall_builder_legacy": false,
  "updated_at": "2025-07-30T11:13:58.798Z",
  "created_at": "2025-07-30T11:13:58.798Z",
  "state": "live",
  "is_deleted": false,
  "web_purchase_url": "https://example.com/purchase",
  "products": [
    {
      "product_id": "b95e9e51-a056-4eb6-9cf7-b75d139e7c3c",
      "title": "Premium Monthly",
      "product_set": "uncategorised",
      "offer": {
        "product_offer_id": "e31a4296-f250-4faf-ac80-3cc93c2da8f5",
        "title": "Free Trial"
      }
    }
  ],
  "remote_configs": [
    {
      "locale": "en",
      "data": "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
    }
  ],
  "main_screenshot": {
    "image_id": 123456,
    "url": "https://public-media.adapty.io/public/screenshot.jpg"
  }
}

Yêu cầu không hợp lệ

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example

{
  "errors": [
    {
      "source": "remote_configs",
      "errors": [
        "At least one field must be provided"
      ]
    }
  ],
  "error_code": "validation_error",
  "status_code": 400
}

Không được phép

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example

{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Không tìm thấy paywall

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example

{
  "errors": [
    {
      "source": null,
      "errors": [
        "Paywall not found"
      ]
    }
  ],
  "error_code": "paywall_does_not_exist",
  "status_code": 404
}

Lỗi máy chủ nội bộ

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Try it

Authorization

Path parameters

paywall_id*

Body

curl --request PUT \
  --url 'https://api.adapty.io/api/v2/server-side-api/paywalls/{paywall_id}/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "remote_configs": [
      {
        "locale": "en",
        "data": "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
      }
    ]
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/paywalls/{paywall_id}/', {
  method: 'PUT',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "remote_configs": [
      {
        "locale": "en",
        "data": "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
      }
    ]
  }),
});
const data = await response.json();

import requests

response = requests.put('https://api.adapty.io/api/v2/server-side-api/paywalls/{paywall_id}/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "remote_configs": [
        {
          "locale": "en",
          "data": "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
        }
      ]
    })
data = response.json()