Agency API Clients

Create a client

POST https://api.tamio.com/v2/clients/create

Creates a new client account. Clients can be created as either demo (for testing) or live (for production). Live clients require quota configuration.

Body Parameters

name string*

Full name of the client/company

email string*

Primary contact email address for the client

country string*

Two-letter country code where the client is located

send_email boolean

Whether to send welcome/setup emails to the client

type string

Client account type

livedemo

quotas object

Resource usage limits for the client account (required for live clients)

JSON

{ "quotas": { "automations_quota": 0, "transaction_quota": 0, "datatransfer_quota": 0, "storage_quota": 0, "languages_quota": 0, "products_quota": 0, "domains_quota": 0, "currencies_quota": 0, "teammates_quota": 0, "api_quota": 0, "newsletters_quota": 0, "ai_quota": 0, "sms_balance": 0 } }

automations_quota integer*

Maximum number of automations allowed

transaction_quota integer*

Maximum number of transactions allowed

datatransfer_quota number*

Maximum data transfer allowed (in GB)

storage_quota number*

Maximum storage space allowed (in GB)

languages_quota integer*

Maximum number of languages supported

products_quota integer*

Maximum number of products allowed

domains_quota integer*

Maximum number of domains allowed

currencies_quota integer*

Maximum number of currencies supported

teammates_quota integer*

Maximum number of team members allowed

api_quota integer*

Maximum number of API calls allowed

newsletters_quota integer*

Maximum number of newsletters allowed

ai_quota integer*

Maximum number of AI operations allowed

sms_balance integer*

Initial SMS credit balance

Example

{
  "name": "Acme Corp",
  "email": "[email protected]",
  "country": "de",
  "send_email": false,
  "type": "live",
  "quotas": {
    "automations_quota": 5,
    "transaction_quota": 100,
    "datatransfer_quota": 2,
    "storage_quota": 5,
    "languages_quota": 2,
    "products_quota": 50,
    "domains_quota": 3,
    "currencies_quota": 2,
    "teammates_quota": 5,
    "api_quota": 1000,
    "newsletters_quota": 500,
    "ai_quota": 100,
    "sms_balance": 50
  }
}

Responses

200 Client created successfully

Client created successfully

status integer

client Client

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`10147`	Agency has no validated domain
`10148`	Email matches an existing account
`10151`	Agency has reached its client limit
`10240`	Requested quota exceeds platform limits
`10272`	A profile already exists with permissions on this domain
`10329`	Agency lacks SMS credits for allocation
`10330`	Agency lacks AI credits for allocation

status integer

error string

error_code integer

401 Unauthorized – invalid or missing Bearer token

Update a client

/clients/create

1 const response = await fetch("https://api.tamio.com/v2/clients/create", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "name": "Acme Corp",
9     "email": "[email protected]",
10     "country": "de",
11     "send_email": false,
12     "type": "live",
13     "quotas": {
14       "automations_quota": 5,
15       "transaction_quota": 100,
16       "datatransfer_quota": 2,
17       "storage_quota": 5,
18       "languages_quota": 2,
19       "products_quota": 50,
20       "domains_quota": 3,
21       "currencies_quota": 2,
22       "teammates_quota": 5,
23       "api_quota": 1000,
24       "newsletters_quota": 500,
25       "ai_quota": 100,
26       "sms_balance": 50
27     }
28   })
29 });
30 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/clients/create")
6 
7 https = Net::HTTP.new(url.host, url.port)
8 https.use_ssl = true
9 
10 request = Net::HTTP::Post.new(url)
11 request["Accept"] = "application/json"
12 request["Authorization"] = "Bearer YOUR_API_KEY"
13 request["Content-Type"] = "application/json"
14 request.body = {
15   name: "Acme Corp",
16   email: "[email protected]",
17   country: "de",
18   send_email: false,
19   type: "live",
20   quotas: {
21     automations_quota: 5,
22     transaction_quota: 100,
23     datatransfer_quota: 2,
24     storage_quota: 5,
25     languages_quota: 2,
26     products_quota: 50,
27     domains_quota: 3,
28     currencies_quota: 2,
29     teammates_quota: 5,
30     api_quota: 1000,
31     newsletters_quota: 500,
32     ai_quota: 100,
33     sms_balance: 50
34   }
35 }.to_json
36 
37 response = https.request(request)
38 puts response.read_body

Responses

{
  "status": 200,
  "client": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "object": "client",
    "customer_id": "660e8400-e29b-41d4-a716-446655440000",
    "email": "[email protected]",
    "telephone": "+49123456789",
    "name": "Acme Corp",
    "country": "de",
    "locale": "en",
    "status": "active",
    "is_demo": false,
    "is_suspended": false,
    "registration_date": 1700000000,
    "admin": {
      "id": 12345,
      "email": "[email protected]",
      "name": "My Agency"
    },
    "business_information": {
      "name": "Acme Online Store",
      "country": "gr",
      "address": "123 Test Street",
      "city": "Athens",
      "postcode": "10431",
      "state": "Attica",
      "offset": "+02:00",
      "telephone": "+30 210 1234567",
      "vat": "123456789",
      "default_currency": "EUR",
      "email": "[email protected]",
      "currency_conversion": true,
      "custom_fields": [
        "Industry",
        "Registration Number"
      ],
      "currencies": [
        "EUR",
        "USD",
        "GBP"
      ],
      "languages": [
        "en",
        "de"
      ],
      "locale": "en",
      "logos": {}
    },
    "billing_plan": {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "object": "subscription",
      "status": "active",
      "type": "subscription",
      "gateway": "stripe",
      "gateway_subscription_id": "sub_1N2m3o4P5q6R7s",
      "billing_cycle": "month",
      "interval": 1,
      "currency": "EUR",
      "price": 2990,
      "lifetime_revenue": 35880,
      "payment_count": 12,
      "has_discount": false,
      "next_billing_date": 1703000000,
      "cancellation_date": null,
      "completion_date": null,
      "resumes_at": null,
      "invoice_id": "880e8400-e29b-41d4-a716-446655440000",
      "instalments_count": 0,
      "imported": false,
      "has_notes": false,
      "products": [],
      "customer": {}
    },
    "quotas": {
      "used_storage": 52428800,
      "storage_quota": 1073741824,
      "used_datatransfer": 5368709120,
      "datatransfer_quota": 107374182400,
      "used_automations": 3,
      "automations_quota": 10,
      "remaining_automations_quota": 7,
      "used_transactions": 15,
      "transaction_quota": 100,
      "used_products": 45,
      "products_quota": 100,
      "used_languages": 2,
      "languages_quota": 3,
      "used_domains": 1,
      "domains_quota": 3,
      "used_currencies": 2,
      "currencies_quota": 3,
      "used_teammates": 5,
      "teammates_quota": 10,
      "used_api": 1250,
      "api_quota": 10000,
      "used_newsletters": 500,
      "newsletters_quota": 1000,
      "used_clients_accounts": 3,
      "client_accounts_quota": 5,
      "used_ai": 25,
      "ai_quota": 100,
      "remaining_ai_quota": 75,
      "used_sms_balance": 50,
      "sms_balance": 200,
      "remaining_sms_balance": 150,
      "email_accounts_quota": 30,
      "used_email_accounts": 12,
      "default_email_slots_per_mailbox": 10,
      "root": {}
    },
    "permissions": {
      "account": {
        "view": true,
        "edit": true,
        "remove": false
      },
      "billing": {
        "view": true,
        "edit": false
      },
      "keys": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "webhooks": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "logs": {
        "view": true
      },
      "audit_trail": {
        "view": true
      },
      "revenue_analytics": {
        "view": true
      },
      "source_analytics": {
        "view": true
      },
      "visitor_analytics": {
        "view": true
      },
      "domains": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "taxes": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "teammates": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "reports": {
        "view": true,
        "edit": true
      },
      "sites": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true,
        "publish": true
      },
      "pages": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "affiliate_programs": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "affiliates": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "affiliate_network": {
        "view": true,
        "edit": true
      },
      "payouts": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "payments": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "integrations": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true,
        "publish": true
      },
      "invoices": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "subscriptions": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "instalment_plans": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "customers": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "subscribers": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "mailing_lists": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "automations": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "discounts": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "email_templates": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "reviews": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "assets": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "products": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "shippings": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "warehouses": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "support": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "clients": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "agency_billing_plans": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      },
      "ai": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": true
      }
    }
  }
}

1	const response = await fetch("https://api.tamio.com/v2/clients/create", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"name": "Acme Corp",
9	"email": "[email protected]",
10	"country": "de",
11	"send_email": false,
12	"type": "live",
13	"quotas": {
14	"automations_quota": 5,
15	"transaction_quota": 100,
16	"datatransfer_quota": 2,
17	"storage_quota": 5,
18	"languages_quota": 2,
19	"products_quota": 50,
20	"domains_quota": 3,
21	"currencies_quota": 2,
22	"teammates_quota": 5,
23	"api_quota": 1000,
24	"newsletters_quota": 500,
25	"ai_quota": 100,
26	"sms_balance": 50
27	}
28	})
29	});
30	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/clients/create")
6
7	https = Net::HTTP.new(url.host, url.port)
8	https.use_ssl = true
9
10	request = Net::HTTP::Post.new(url)
11	request["Accept"] = "application/json"
12	request["Authorization"] = "Bearer YOUR_API_KEY"
13	request["Content-Type"] = "application/json"
14	request.body = {
15	name: "Acme Corp",
16	email: "[email protected]",
17	country: "de",
18	send_email: false,
19	type: "live",
20	quotas: {
21	automations_quota: 5,
22	transaction_quota: 100,
23	datatransfer_quota: 2,
24	storage_quota: 5,
25	languages_quota: 2,
26	products_quota: 50,
27	domains_quota: 3,
28	currencies_quota: 2,
29	teammates_quota: 5,
30	api_quota: 1000,
31	newsletters_quota: 500,
32	ai_quota: 100,
33	sms_balance: 50
34	}
35	}.to_json
36
37	response = https.request(request)
38	puts response.read_body