## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.terminal3.io/llms.txt)

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

### cURL Example

```
curl --request POST \
  --url https://staging.terminal3.io/v1/sub_client \
  --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

```
import requests

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

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.post(url, json=payload, headers=headers)

print(response.text)
```

### JavaScript Fetch API Example

```
const options = {
  method: 'POST',
  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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

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>\"}\n")

req, _ := http.NewRequest("POST", 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))
}
```

### Unirest Java Example

```
HttpResponse<String> response = Unirest.post("https://staging.terminal3.io/v1/sub_client")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\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>\"}")
  .asString();
```

### Ruby Example

```
require 'uri'
require 'net/http'

url = URI("https://staging.terminal3.io/v1/sub_client")

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

request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\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>\"}"

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

### Expected Responses

#### Success Response

```
{
  "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 Response

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

### Headers

- **x-api-token**: `string`, required
- **x-api-subclient-id**: `string`

### Body Parameters

- **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`.