Put v1sub client - Terminal 3 Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request PUT \
  --url https://staging.terminal3.io/v1/sub_client/{subclient_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "name": "<string>",
  "address_1": "<string>",
  "address_2": "<string>",
  "country": "<string>",
  "province": "<string>",
  "city": "<string>",
  "timezone": "<string>",
  "domain": "<string>",
  "subdomain": "<string>"
}
'```

### Python Example

```python
import requests

url = "https://staging.terminal3.io/v1/sub_client/{subclient_id}"

payload = {
    "name": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "country": "<string>",
    "province": "<string>",
    "city": "<string>",
    "timezone": "<string>",
    "domain": "<string>",
    "subdomain": "<string>"
}
headers = {
    "x-api-token": "<x-api-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript Example

const options = {
  method: 'PUT',
  headers: {'x-api-token': '<x-api-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    address_1: '<string>',
    address_2: '<string>',
    country: '<string>',
    province: '<string>',
    city: '<string>',
    timezone: '<string>',
    domain: '<string>',
    subdomain: '<string>'
  })
};

fetch('https://staging.terminal3.io/v1/sub_client/{subclient_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP Example

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.terminal3.io/v1/sub_client/{subclient_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",\n  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'address_1' => '<string>',
    'address_2' => '<string>',
    'country' => '<string>',
    'province' => '<string>',
    'city' => '<string>',
    'timezone' => '<string>',
    'domain' => '<string>',
    'subdomain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-token: <x-api-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go Example

package main

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

func main() {
    
    url := "https://staging.terminal3.io/v1/sub_client/{subclient_id}"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"address_1\": \"<string>\",\n  \"address_2\": \"<string>\",\n  \"country\": \"<string>\",\n  \"province\": \"<string>\",\n  \"city\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"subdomain\": \"<string>\"}")

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

req.Header.Add("x-api-token", "<x-api-token>")
    req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))
}

Response Structure

{
  "data": {
    "client_id": 123,
    "name": "<string>",
    "domain": "<string>",
    "timezone": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "country": "<string>",
    "province": "<string>",
    "city": "<string>",
    "subdomain": "<string>",
    "from_email_address": "<string>",
    "esp_token": "<string>",
    "recaptcha_key": "<string>",
    "recaptcha_threshold": 123,
    "recaptcha_enabled": true,
    "created_at": "<string>",
    "privacy_link": "<string>"
  }
}

Error Structure

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Required Headers

• x-api-token: string (required)
• x-api-subclient-id: string (required)

Path Parameters

• subclient_id: number (required, must be greater than 0)

Body Structure

• name: string (required, length: 1-70)
• address_1: string (required, length: 1-100)
• address_2: string (required, length: 1-100)
• country: string (minimum length: 1)
• province: string (minimum length: 1)
• city: string (minimum length: 1)
• timezone: string
• domain: string
• subdomain: string

Possible Response Codes

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 422: Unprocessable Entity