keywords

Set an iOS keyword field

Replaces the keyword field of one App Store localization with the normalized, deduplicated phrases of text, tracks them in country, and returns the stored field. Without a query it sets the home storefront’s default localization. Answers 400 when the storefront does not read the localization, or when the phrases joined with commas run past 100 characters, the way App Store Connect counts the field. A phrase removed from the field stops being tracked as a keyword field phrase in every market that reads the localization. Saves to one app are written one at a time, so the last save wins.

PUT

/

apps

/

{id}

/

keyword-field

Set an iOS keyword field

curl --request PUT \
  --url http://localhost:3000/api/backend/apps/{id}/keyword-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "habit,tracker,streak,daily goals"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: 'habit,tracker,streak,daily goals'})
};

fetch('http://localhost:3000/api/backend/apps/{id}/keyword-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/backend/apps/{id}/keyword-field"

payload = { "text": "habit,tracker,streak,daily goals" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string

required

Query Parameters

country

string

The storefront the field is read in and its phrases are tracked in. Omitted means the home storefront.

Pattern: ^[a-z]{2}$

Example:

"us"

localization

enum<string>

The App Store localization whose keyword field this is. It must be one the storefront reads. Omitted means the storefront's default localization.

Available options:

ar,

bn,

ca,

zh-Hans,

zh-Hant,

hr,

cs,

da,

nl,

en-AU,

en-CA,

en-GB,

en-US,

fi,

fr,

fr-CA,

de,

el,

gu,

he,

hi,

hu,

id,

it,

ja,

kn,

ko,

ms,

ml,

mr,

no,

or,

pl,

pt-BR,

pt-PT,

pa,

ro,

ru,

sk,

sl,

es-MX,

es-ES,

sv,

ta,

te,

th,

tr,

uk,

ur,

vi

Example:

"es-MX"

Body

application/json

text

string

required

Maximum string length: 1000

Example:

"habit,tracker,streak,daily goals"

Response

200 - application/json

The response is of type object.

Set an iOS keyword field

curl --request PUT \
  --url http://localhost:3000/api/backend/apps/{id}/keyword-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "habit,tracker,streak,daily goals"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: 'habit,tracker,streak,daily goals'})
};

fetch('http://localhost:3000/api/backend/apps/{id}/keyword-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/backend/apps/{id}/keyword-field"

payload = { "text": "habit,tracker,streak,daily goals" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{}