Metadata (Localizations)

App Store metadata is stored per locale (language) and per version. Use version localizations to manage description, keywords, promotional text, what’s new, support URL, and marketing URL.

name and subtitle in the App Information tab are not version-localization fields.
Use App Info localization endpoints instead:

GET /v1/connect/apps/:appId/app-infos
GET /v1/connect/app-infos/:appInfoId/localizations
PATCH /v1/connect/app-info-localizations/:localizationId

Most metadata can only be updated when the app is in an editable state (e.g. PREPARE_FOR_SUBMISSION). Promotional text can be updated at any time, even when the app is live.

List Localizations

GET /v1/connect/versions/:versionId/localizations

List all localizations (languages) for an App Store version. Use the version ID from List Versions.

Path Parameters

Name	Type	Description
versionId	string	App Store version ID (e.g. `c2db5998-ac17-47b5-a61a-3658540592f8`)

Response

{
  "data": {
    "data": [
      {
        "type": "appStoreVersionLocalizations",
        "id": "e3c96adf-bba6-4459-8c3a-ed9c54f81af8",
        "attributes": {
          "locale": "en-US",
          "description": "Tape Record turns your voice into beautifully styled recordings...",
          "keywords": "record, voice, audio, cassette",
          "promotionalText": null,
          "whatsNew": "* Bug fixes\n* Performance improvements",
          "supportUrl": "https://webmob.ee/support",
          "marketingUrl": null
        }
      }
    ]
  }
}

Attribute Reference

Field	Description	Editable When
description	Full app description (max 4000 chars)	Editable state
keywords	Comma-separated keywords (max 100 chars)	Editable state
promotionalText	Promotional text (max 170 chars)	Anytime
whatsNew	”What’s New in This Version” (max 4000 chars)	Editable state
supportUrl	Support URL	Editable state
marketingUrl	Marketing URL	Editable state
locale	Language (e.g. `en-US`, `tr`)	Set at creation

Get Localization

GET /v1/connect/localizations/:localizationId

Get a single localization’s metadata.

Update Localization

PATCH /v1/connect/localizations/:localizationId

Update metadata for a localization. Send only the attributes you want to change.

Request Body

{
  "attributes": {
    "description": "Updated app description...",
    "keywords": "record, voice, audio, tape, memo",
    "whatsNew": "* Bug fixes\n* New tape styles",
    "promotionalText": "Try the new neon tape!",
    "supportUrl": "https://example.com/support",
    "marketingUrl": "https://example.com"
  }
}

Attribute	Type	Max Length
description	string	4000
keywords	string	100
promotionalText	string	170
whatsNew	string	4000
supportUrl	string	—
marketingUrl	string	—

Keywords: Use commas to separate. No spaces after commas. Apple recommends 5–10 high-value keywords. Avoid duplication with your app name and subtitle.

Create Localization

POST /v1/connect/versions/:versionId/localizations

Add a new language to a version (the version must be in an editable state).

{
  "locale": "de-DE",
  "attributes": {
    "description": "Tape Record verwandelt deine Stimme...",
    "keywords": "aufnahme,stimme,audio,kassette",
    "whatsNew": "* Fehlerbehebungen",
    "supportUrl": "https://webmob.ee/support"
  }
}

locale is required; all attributes are optional and can be patched later. For App Information languages (name, subtitle), use POST /v1/connect/app-infos/:appInfoId/localizations with { "locale": "de-DE", "attributes": { "name": "...", "subtitle": "..." } }.

Delete Localization

DELETE /v1/connect/localizations/:localizationId
DELETE /v1/connect/app-info-localizations/:localizationId

Removes a language from the version or app info. Only possible while the version is editable.

Bulk Localization Workflow

For translating an entire version in one call (all locales, AI-assisted), see the higher-level endpoints:

GET  /v1/connect/localizations/live       → current live metadata for all locales
POST /v1/connect/localizations/pull       → pull App Store metadata into Appeeky
POST /v1/connect/localizations/publish    → publish translated metadata to App Store
POST /v1/connect/localizations/remove     → remove locales in bulk

Code Example

# List localizations for a version
curl -X GET "https://api.appeeky.com/v1/connect/versions/c2db5998-ac17-47b5-a61a-3658540592f8/localizations" \
  -H "X-API-Key: YOUR_APEEKY_KEY" \
  -H "X-ASC-Issuer-Id: YOUR_ISSUER_ID" \
  -H "X-ASC-Key-Id: YOUR_KEY_ID" \
  -H "X-ASC-Private-Key: YOUR_PRIVATE_KEY"

# Update keywords
curl -X PATCH "https://api.appeeky.com/v1/connect/localizations/e3c96adf-bba6-4459-8c3a-ed9c54f81af8" \
  -H "X-API-Key: YOUR_APEEKY_KEY" \
  -H "X-ASC-Issuer-Id: YOUR_ISSUER_ID" \
  -H "X-ASC-Key-Id: YOUR_KEY_ID" \
  -H "X-ASC-Private-Key: YOUR_PRIVATE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"attributes":{"keywords":"record,voice,audio,cassette,memo"}}'

// Update promotional text (can be done anytime, even when app is live)
const response = await fetch(
  "https://api.appeeky.com/v1/connect/localizations/e3c96adf-bba6-4459-8c3a-ed9c54f81af8",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "YOUR_APEEKY_KEY",
      "X-ASC-Issuer-Id": "YOUR_ISSUER_ID",
      "X-ASC-Key-Id": "YOUR_KEY_ID",
      "X-ASC-Private-Key": process.env.ASC_PRIVATE_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      attributes: {
        promotionalText: "New: Neon tape style and dark mode!",
      },
    }),
  }
);

Getting Started

Apps

My Data - Appeeky Web

Keywords

ASO Tools

AI Visibility

Search & Discovery

Market Intelligence

RevenueCat

App Store Connect

Google Play Console

Apple Search Ads

Growth Channels

Reference

List Localizations

Path Parameters

Response

Attribute Reference

Get Localization

Update Localization

Request Body

Create Localization

Delete Localization

Bulk Localization Workflow

Code Example

​List Localizations

​Path Parameters

​Response

​Attribute Reference

​Get Localization

​Update Localization

​Request Body

​Create Localization

​Delete Localization

​Bulk Localization Workflow

​Code Example

List Localizations

Path Parameters

Response

Attribute Reference

Get Localization

Update Localization

Request Body

Create Localization

Delete Localization

Bulk Localization Workflow

Code Example