Save Smart App Banner config

PUT /api/apps/{appId}/site/smart-banner

Parameters

appIdrequired string The app's unique identifier Example: -NtestApp123

Request Body

appStoreIdrequired string Numeric App Store ID Max 20 characters · Pattern: digits only

affiliateData string Max 200 characters

appArgument string Max 500 characters

appClipBundleId string Max 200 characters

appClipDisplay string bannercard

Responses

appStoreIdrequired string Numeric App Store ID Max 20 characters · Pattern: digits only

affiliateData string Max 200 characters

appArgument string Max 500 characters

appClipBundleId string Max 200 characters

appClipDisplay string bannercard

errorrequired object

coderequired string Machine-readable error code UNAUTHORIZEDFORBIDDENNOT_FOUNDVALIDATION_FAILEDRATE_LIMITEDSLUG_TAKENSLUG_RESERVEDDOMAIN_IN_USEAPP_LIMIT_REACHEDSUBSCRIPTION_REQUIREDSUBSCRIPTION_EXISTSNO_PAYMENT_METHODNO_ACTIVE_SUBSCRIPTIONNOT_CANCELINGALREADY_CANCELINGSUBSCRIPTION_CANCELINGSAME_PLANCARD_ERRORPAYMENT_ERRORNO_STRIPE_CUSTOMERCERT_CREATION_FAILEDDEPLOY_FAILEDAPI_KEY_LIMIT_REACHEDINVALID_IDEMPOTENCY_KEYIDEMPOTENCY_KEY_REUSEINTERNAL_ERROR

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

Language

URL

PUT https://api.orbitkit.io/api/apps/{appId}/site/smart-banner

curl -X PUT "https://api.orbitkit.io/api/apps/-NtestApp123/site/smart-banner" \
  -H "Authorization: Bearer $ORBITKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"appStoreId":"string","affiliateData":"string","appArgument":"string","appClipBundleId":"string","appClipDisplay":"banner"}'

const response = await fetch(`https://api.orbitkit.io/api/apps/-NtestApp123/site/smart-banner`, {
  method: "PUT",
  headers: {
    "Authorization": "Bearer " + apiKey,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "appStoreId": "string",
      "affiliateData": "string",
      "appArgument": "string",
      "appClipBundleId": "string",
      "appClipDisplay": "banner"
  }),
});

const data = await response.json();
console.log(data);

var request = URLRequest(url: URL(string: "https://api.orbitkit.io/api/apps/-NtestApp123/site/smart-banner")!)
request.httpMethod = "PUT"
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

let body: [String: Any] = ["appStoreId": "string", "affiliateData": "string", "appArgument": "string", "appClipBundleId": "string", "appClipDisplay": "banner"]
request.httpBody = try JSONSerialization.data(withJSONObject: body)

let (data, _) = try await URLSession.shared.data(for: request)
let json = try JSONSerialization.jsonObject(with: data)
print(json)

200

{
  "appStoreId": "string",
  "affiliateData": "string",
  "appArgument": "string",
  "appClipBundleId": "string",
  "appClipDisplay": "banner"
}

400

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Validation failed",
    "docUrl": "https://orbitkit.io/api/errors/#validation-failed",
    "details": [
      {
        "field": "appName",
        "message": "Required"
      }
    ]
  }
}

401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token",
    "docUrl": "https://orbitkit.io/api/errors/#unauthorized"
  }
}