{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/branch-metrics/main/json-schema/branch-metrics-put-v1-app-branchkey-request-schema.json",
  "title": "PutV1AppBranchkeyRequest",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/branch-metrics-openapi-generated.yml#/components/schemas/PutV1AppBranchkeyRequest",
  "type": "object",
  "properties": {
    "branch_secret": {
      "type": "string",
      "description": "The Branch secret if the originating app; from your Branch Settings Dashboard"
    },
    "app_name": {
      "type": "string",
      "description": "The name of the app (max 255 characters)."
    },
    "dev_name": {
      "type": "string",
      "description": "The main contact developer name (max 255 characters)."
    },
    "dev_email": {
      "type": "string",
      "description": "The main contact developer email (max 255 characters)."
    },
    "android_url": {
      "type": "string",
      "description": "The url of the Android store, or package name (com.android.myapp). Note that to set a fallback URL for Android instead, you must also set `android_app` to `2`."
    },
    "android_uri_scheme": {
      "type": "string",
      "description": "The Android URI scheme."
    },
    "ios_url": {
      "type": "string",
      "description": "The url of iOS store, or app id (id512451233)"
    },
    "ios_uri_scheme": {
      "type": "string",
      "description": "The iOS URI scheme."
    },
    "ios_store_country": {
      "type": "string",
      "description": "The country code of the app, default to US (max 255 characters)."
    },
    "web_url": {
      "type": "string",
      "description": "Backup website if URLs are null."
    },
    "text_message": {
      "type": "string",
      "description": "The text message to use for text-me feature, {{ link }} will be replaced with short link (max 255 characters)."
    },
    "og_app_id": {
      "type": "string",
      "description": "Default Open Graph (OG) app id (max 255 characters)."
    },
    "og_title": {
      "type": "string",
      "description": "Default OG title to be used with links (max 255 characters)."
    },
    "og_description": {
      "type": "string",
      "description": "Default OG description to be used with links (max 255 characters)."
    },
    "og_image_url": {
      "type": "string",
      "description": "Default OG image URL to be used with links (max 255 characters)."
    }
  },
  "required": [
    "branch_secret",
    "dev_email"
  ]
}