Syndai Docs

Edit one listing field's draft

PATCH
/api/v1/external/coding/customers/{customer_id}/repositories/{repository_id}/store/listing

Saves value as the draft of field in the store locale (locale is the store's own code: ja on Apple, ja-JP on Play); "" or the live text drops the draft. Any change clears that locale's tick. A locale the store doesn't show yet needs a language the app's UI speaks (409 language_not_in_app). Nothing reaches the store until the locale is ticked and pushed. Signed-in owners and admins only.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

customer_id*string
Formatuuid
repository_id*string
Formatuuid

Request Body

application/json
  1. body
field*string
Length1 <= length <= 40
locale*string
Length2 <= length <= 16
platform*string
Value in"ios""android"
value*string
Lengthlength <= 16000

Response Body

Request fulfilled, document follows

application/json
  1. response
adopted*boolean
editable?
imported_at?string|null
languages?array<>
locales*array<>
review?
work?|null
Example Request
curl -X PATCH 'https://api.syndai.ai/api/v1/external/coding/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/repositories/497f6eca-6276-4993-bfeb-53cbbbba6f08/store/listing' \  -H 'Content-Type: application/json' \  -d '{  "field": "string",  "locale": "string",  "platform": "ios",  "value": "string"}'
Example Response
{  "adopted": true,  "editable": {    "property1": true,    "property2": true  },  "imported_at": "string",  "languages": [    {      "apple": "string",      "in_app": true,      "key": "string",      "listed": true,      "name": "string",      "play": "string",      "translation_requested": false    }  ],  "locales": [    {      "captures": [        {          "ai_generated": true,          "artwork_model": "string",          "artwork_sha256": "string",          "caption": "string",          "caption_back_translation": "string",          "display_type": "string",          "height": 0,          "kind": "string",          "order": 0,          "output_review": {            "artifact_sha256": "string",            "issues": [              {                "category": "string",                "evidence": "string",                "suggestion": "string"              }            ],            "language": "string",            "model": "string",            "source_sha256": "string",            "status": "clear",            "version": 0          },          "pick": 0,          "pii": "string",          "problems": [            "string"          ],          "sha256": "string",          "source": "syndai",          "source_commit": "string",          "source_sha256": "string",          "source_tree": "string",          "url": "string",          "width": 0        }      ],      "fields": [        {          "back_translation": "string",          "draft": "string",          "field": "string",          "limit": 0,          "live": "string",          "over": 0,          "repo": "string",          "unit": "string"        }      ],      "locale": "string",      "platform": "string",      "shots": [        {          "ai_generated": true,          "artwork_model": "string",          "artwork_sha256": "string",          "caption": "string",          "caption_back_translation": "string",          "display_type": "string",          "height": 0,          "kind": "string",          "order": 0,          "output_review": {            "artifact_sha256": "string",            "issues": [              {                "category": "string",                "evidence": "string",                "suggestion": "string"              }            ],            "language": "string",            "model": "string",            "source_sha256": "string",            "status": "clear",            "version": 0          },          "pick": 0,          "pii": "string",          "problems": [            "string"          ],          "sha256": "string",          "source": "syndai",          "source_commit": "string",          "source_sha256": "string",          "source_tree": "string",          "url": "string",          "width": 0        }      ],      "state": "string",      "ticked_at": "string"    }  ],  "review": {    "demo_kind": "string",    "demo_username": "string",    "needs_login": false,    "notes": "string",    "refusal": "string"  },  "work": {    "error": {      "detail": "string",      "kind": "string"    },    "id": "string",    "items": [      {        "locale": "string",        "platform": "string",        "state": "string"      }    ],    "kind": "string",    "requested_at": "string",    "state": "string",    "updated_at": "string"  }}