Update a string

PUThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/strings/{string_id}

Language

Credentials

Secret key

Instance keyRemember on this device

Kept in this browser tab unless you tick Remember; don't on a shared computer. Use keys from a sandbox account to test without moving money.

Parameters

Path

string_idrequired

Body application/json

cURL request

curl --request PUT \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings/STRING_ID \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>' \
  --header 'Content-Type: application/json' \
  --data '{
  "string": {
    "text": "رقم البطاقة",
    "language": "ar"
  }
}'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings/STRING_ID';
const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <base64 of SECRET_KEY:>',
    'Content-Type': 'application/json'
  },
  body: '{"string":{"text":"رقم البطاقة","language":"ar"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings/STRING_ID"

payload = { "string": {
        "text": "رقم البطاقة",
        "language": "ar"
    } }
headers = {
    "Authorization": "Basic <base64 of SECRET_KEY:>",
    "Content-Type": "application/json"
}

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

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings/STRING_ID', [
  'body' => '{
  "string": {
    "text": "رقم البطاقة",
    "language": "ar"
  }
}',
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings/STRING_ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"string\": {\n    \"text\": \"رقم البطاقة\",\n    \"language\": \"ar\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings/STRING_ID"

  payload := strings.NewReader("{\n  \"string\": {\n    \"text\": \"رقم البطاقة\",\n    \"language\": \"ar\"\n  }\n}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

curl --request PUT \
  --url https://app.shuttleglobal.com/c/api/strings/STRING_ID \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "string": {
    "text": "رقم البطاقة",
    "language": "ar"
  }
}'

const url = 'https://app.shuttleglobal.com/c/api/strings/STRING_ID';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{"string":{"text":"رقم البطاقة","language":"ar"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/strings/STRING_ID"

payload = { "string": {
        "text": "رقم البطاقة",
        "language": "ar"
    } }
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

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

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.shuttleglobal.com/c/api/strings/STRING_ID', [
  'body' => '{
  "string": {
    "text": "رقم البطاقة",
    "language": "ar"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/strings/STRING_ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"string\": {\n    \"text\": \"رقم البطاقة\",\n    \"language\": \"ar\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/strings/STRING_ID"

  payload := strings.NewReader("{\n  \"string\": {\n    \"text\": \"رقم البطاقة\",\n    \"language\": \"ar\"\n  }\n}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response

The string as it now reads

{
  "string": {
    "id": "web.payment_form.card_number",
    "text": "رقم البطاقة",
    "language": "ar",
    "branding": "string",
    "overriding": "Card Number"
  }
}

PUT

/strings/{string_id}

Replaces the wording of one string for one language.

The fields go inside a string object. The string is identified by the id in the URL.
language and branding are read from the body, not the query string. Leaving out language writes the default (base) wording, not a translation.
Sending the wording the string already inherits removes your override instead of storing it, so the string goes back to the inherited wording.
Saving the first string in a language adds that language. There is no separate step to add a language.

The change applies to checkouts opened after it is saved. A checkout session that was already created keeps the wording it was created with until it expires.

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

string_id

required

string

The string’s id, e.g. web.payment_form.card_number.

Request Body^required

application/json

object

string

required

object

text

required

string

The new wording

language

string

Lowercase two-letter ISO 639-1 language code, or default. Defaults to default, so send it when writing a translation

branding

string

Enterprise field, for accounts with more than one branding. Leave out to use your own branding

Example

{
  "string": {
    "text": "رقم البطاقة",
    "language": "ar"
  }
}

Responses

200

The string as it now reads

application/json

object

string

object

A customer-facing string and the wording that applies for one language

object

string

e.g. "web.payment_form.card_number"

String id, <set>.<key>

text

string

e.g. "رقم البطاقة"

The wording that currently applies

language

string

e.g. "ar"

Language the wording applies to

branding

string

Enterprise field. The branding the wording applies to

overriding

string

e.g. "Card Number"

Present only when the string has its own wording for this language. Holds the wording it would otherwise inherit, which is what it goes back to if reset

400

Bad request

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

401

Authentication required

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Example

{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}

Was this page helpful?

Update a string

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

401

Request Body^required