Update several strings

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

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

Body application/json

cURL request

curl --request POST \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>' \
  --header 'Content-Type: application/json' \
  --data '{
  "strings": [
    "string"
  ]
}'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <base64 of SECRET_KEY:>',
    'Content-Type': 'application/json'
  },
  body: '{"strings":["string"]}'
};

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"

payload = { "strings": ["string"] }
headers = {
    "Authorization": "Basic <base64 of SECRET_KEY:>",
    "Content-Type": "application/json"
}

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

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings', [
  'body' => '{
  "strings": [
    "string"
  ]
}',
  '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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"strings\": [\n    \"string\"\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"

  payload := strings.NewReader("{\n  \"strings\": [\n    \"string\"\n  ]\n}")

  req, _ := http.NewRequest("POST", 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 POST \
  --url https://app.shuttleglobal.com/c/api/strings \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "strings": [
    "string"
  ]
}'

const url = 'https://app.shuttleglobal.com/c/api/strings';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{"strings":["string"]}'
};

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"

payload = { "strings": ["string"] }
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

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

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.shuttleglobal.com/c/api/strings', [
  'body' => '{
  "strings": [
    "string"
  ]
}',
  '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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"strings\": [\n    \"string\"\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"

  payload := strings.NewReader("{\n  \"strings\": [\n    \"string\"\n  ]\n}")

  req, _ := http.NewRequest("POST", 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 updated strings as they now read

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

POST

/strings

Updates the wording of several strings in one request, for one language. Strings not included are left as they are.

Every item in one request must use the same language (and branding, if you send it). Send one request per language.
Each item is applied as Update a string would apply it: sending the wording the string already inherits removes your override.
An id whose set (the part before the first dot) is not recognised rejects the request before anything is written. Only use ids returned by List strings.
The update is not atomic. Sets are written one after another, so a failure part-way leaves the earlier sets saved. Re-sending the same request is safe.
Send requests one at a time. Writes to a branding are queued, and a write still waiting after 10 seconds is refused (BOLT-7059).
The request body must be under 10 MB.

Authorizations

basicAuth
bearerAuth

Request Body^required

application/json

object

strings

required

Array

object

required

string

String id, <set>.<key>

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

{
  "strings": [
    {
      "id": "web.payment_form.card_number",
      "text": "رقم البطاقة",
      "language": "ar"
    },
    {
      "id": "web.payment_processing.error",
      "text": "حدثت مشكلة أثناء معالجة الدفع.",
      "language": "ar"
    }
  ]
}

Responses

200

The updated strings as they now read

application/json

object

strings

Array<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 several strings

Authorizations

Request Bodyrequired

Responses

200

400

401

Request Body^required