Metadata API

Manage your app's metadata across App Store and Play Store, including titles, descriptions, keywords, and what's new text.

Metadata is stored per locale. Use the Translation API to automatically translate metadata to new languages.

Get metadata for all locales in a project.

GET /projects/:projectId/metadata

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID

Response Example

{
  "success": true,
  "data": {
    "metadata": {
      "en-US": {
        "locale": "en-US",
        "name": "My Awesome App",
        "subtitle": "The best app ever",
        "description": "Full app description here...",
        "keywords": "productivity, tasks, todo",
        "whatsNew": "Bug fixes and performance improvements",
        "promotionalText": "Try our new features!",
        "updatedAt": "2024-01-20T14:45:00Z"
      },
      "es-ES": {
        "locale": "es-ES",
        "name": "Mi Aplicación Increíble",
        "subtitle": "La mejor aplicación",
        "description": "Descripción completa aquí...",
        "keywords": "productividad, tareas, pendientes",
        "whatsNew": "Correcciones de errores",
        "promotionalText": "¡Prueba nuestras nuevas funciones!",
        "updatedAt": "2024-01-20T14:45:00Z"
      }
    },
    "locales": ["en-US", "es-ES"]
  }
}

Code Examples

curl https://api.appstorecopilot.com/v1/projects/proj_abc123/metadata \
  -H "Authorization: Bearer $ASC_API_KEY"

Get metadata for a specific locale.

GET /projects/:projectId/metadata/:locale

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID
`locale`	`string`	Yes	The locale code (e.g., "en-US", "es-ES")

Response Example

{
  "success": true,
  "data": {
    "metadata": {
      "locale": "en-US",
      "name": "My Awesome App",
      "subtitle": "The best app ever",
      "description": "Full app description here...",
      "keywords": "productivity, tasks, todo",
      "whatsNew": "Bug fixes and performance improvements",
      "promotionalText": "Try our new features!",
      "updatedAt": "2024-01-20T14:45:00Z"
    }
  }
}

Code Examples

curl https://api.appstorecopilot.com/v1/projects/proj_abc123/metadata/en-US \
  -H "Authorization: Bearer $ASC_API_KEY"

Update metadata for a specific locale. All fields are optional; only provided fields will be updated.

PUT /projects/:projectId/metadata/:locale

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID
`locale`	`string`	Yes	The locale code

Request Body

Name	Type	Required	Description
`name`	`string`	No	App name (max 30 chars for App Store)
`subtitle`	`string`	No	App subtitle (max 30 chars for App Store)
`description`	`string`	No	Full app description (max 4000 chars)
`keywords`	`string`	No	Comma-separated keywords (max 100 chars for App Store)
`whatsNew`	`string`	No	What's new text for the current version
`promotionalText`	`string`	No	Promotional text (max 170 chars for App Store)

Response Example

{
  "success": true,
  "data": {
    "metadata": {
      "locale": "en-US",
      "name": "My Awesome App",
      "subtitle": "Now even better!",
      "description": "Updated description...",
      "keywords": "productivity, tasks, todo, new",
      "whatsNew": "New features added!",
      "promotionalText": "Try our new features!",
      "updatedAt": "2024-01-21T10:00:00Z"
    }
  }
}

Code Examples

curl -X PUT https://api.appstorecopilot.com/v1/projects/proj_abc123/metadata/en-US \
  -H "Authorization: Bearer $ASC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subtitle": "Now even better!",
    "whatsNew": "New features added!"
  }'

Delete metadata for a specific locale.

DELETE /projects/:projectId/metadata/:locale

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID
`locale`	`string`	Yes	The locale code

Response Example

{
  "success": true,
  "data": {
    "deleted": true
  }
}

Code Examples

curl -X DELETE https://api.appstorecopilot.com/v1/projects/proj_abc123/metadata/es-ES \
  -H "Authorization: Bearer $ASC_API_KEY"

Get a list of all locales with metadata in a project.

GET /projects/:projectId/locales

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`projectId`	`string`	Yes	The project ID

Response Example

{
  "success": true,
  "data": {
    "locales": [
      {
        "code": "en-US",
        "name": "English (US)",
        "hasMetadata": true,
        "updatedAt": "2024-01-20T14:45:00Z"
      },
      {
        "code": "es-ES",
        "name": "Spanish (Spain)",
        "hasMetadata": true,
        "updatedAt": "2024-01-20T14:45:00Z"
      }
    ]
  }
}

Code Examples

curl https://api.appstorecopilot.com/v1/projects/proj_abc123/locales \
  -H "Authorization: Bearer $ASC_API_KEY"

Available Locales

The following locales are supported for both App Store and Play Store:

Code	Language
`en-US`	English (US)
`en-GB`	English (UK)
`es-ES`	Spanish (Spain)
`es-MX`	Spanish (Mexico)
`fr-FR`	French
`de-DE`	German
`it-IT`	Italian
`pt-BR`	Portuguese (Brazil)
`pt-PT`	Portuguese (Portugal)
`ja-JP`	Japanese
`ko-KR`	Korean
`zh-CN`	Chinese (Simplified)
`zh-TW`	Chinese (Traditional)

See the full list of 40+ supported locales.