Create a teammate

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

Creates a new teammate with a specified role and optional custom permissions. An invitation email is sent to the provided address. When role is custom, the permissions object is required.

Body Parameters

name string*

First name of the teammate.

last_name string

Last name of the teammate.

email string*

Email address for the teammate account. Must not belong to the account owner or an existing teammate.

role string*

Predefined role or custom for granular permissions. administrator has full access, accountant focuses on financials, developer on technical areas, marketer on content/campaigns, guest has minimal access, and fulfilment handles order processing.

accountantdevelopermarketerguestfulfilmentadministrator

custom

country string*

ISO country code for the teammate's geographical context.

permissions Permissions

Responses

200 Teammate created

Teammate created

status integer

teammate Teammate

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`10031`	Teammate quota reached
`10032`	Email cannot be used (matches account owner)
`10033`	A teammate with this email already exists
`10034`	Invalid permissions (custom role requires valid permissions object)

status integer

error string

error_code integer

401 Missing or invalid API key

Retrieve a teammate

Update a teammate

/teammates/create

1 const response = await fetch("https://api.tamio.com/v2/teammates/create", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "name": "John",
9     "last_name": "Doe",
10     "email": "[email protected]",
11     "role": "developer",
12     "country": "US",
13     "permissions": {
14       "account": {
15         "view": false,
16         "edit": false,
17         "remove": false
18       },
19       "billing": {
20         "view": false,
21         "edit": false
22       },
23       "keys": {
24         "view": false,
25         "edit": false,
26         "create": false,
27         "remove": false
28       },
29       "webhooks": {
30         "view": false,
31         "edit": false,
32         "create": false,
33         "remove": false
34       },
35       "logs": {
36         "view": false
37       },
38       "audit_trail": {
39         "view": false
40       },
41       "revenue_analytics": {
42         "view": false
43       },
44       "source_analytics": {
45         "view": false
46       },
47       "visitor_analytics": {
48         "view": false
49       },
50       "domains": {
51         "view": false,
52         "edit": false,
53         "create": false,
54         "remove": false
55       },
56       "taxes": {
57         "view": false,
58         "edit": false,
59         "create": false,
60         "remove": false
61       },
62       "teammates": {
63         "view": false,
64         "edit": false,
65         "create": false,
66         "remove": false
67       },
68       "reports": {
69         "view": false,
70         "edit": false
71       },
72       "sites": {
73         "view": false,
74         "edit": false,
75         "create": false,
76         "remove": false,
77         "publish": false,
78         "site": {}
79       },
80       "pages": {
81         "view": false,
82         "edit": false,
83         "create": false,
84         "remove": false,
85         "page": {}
86       },
87       "affiliate_programs": {
88         "view": false,
89         "edit": false,
90         "create": false,
91         "remove": false
92       },
93       "affiliates": {
94         "view": false,
95         "edit": false,
96         "remove": false
97       },
98       "affiliate_network": {
99         "view": false,
100         "edit": false
101       },
102       "payouts": {
103         "view": false,
104         "edit": false,
105         "create": false,
106         "remove": false
107       },
108       "payments": {
109         "view": false,
110         "edit": false,
111         "remove": false
112       },
113       "integrations": {
114         "view": false,
115         "edit": false,
116         "create": false,
117         "remove": false,
118         "publish": false,
119         "integration": {}
120       },
121       "invoices": {
122         "view": false,
123         "edit": false,
124         "create": false,
125         "remove": false
126       },
127       "subscriptions": {
128         "view": false,
129         "edit": false,
130         "remove": false
131       },
132       "instalment_plans": {
133         "view": false,
134         "edit": false,
135         "remove": false
136       },
137       "customers": {
138         "view": false,
139         "edit": false,
140         "create": false,
141         "remove": false,
142         "customer": {}
143       },
144       "subscribers": {
145         "view": false,
146         "edit": false,
147         "create": false,
148         "remove": false
149       },
150       "mailing_lists": {
151         "view": false,
152         "edit": false,
153         "create": false,
154         "remove": false,
155         "mailing_list": {}
156       },
157       "automations": {
158         "view": false,
159         "edit": false,
160         "create": false,
161         "remove": false
162       },
163       "discounts": {
164         "view": false,
165         "edit": false,
166         "create": false,
167         "remove": false
168       },
169       "email_templates": {
170         "view": false,
171         "edit": false,
172         "create": false,
173         "remove": false
174       },
175       "reviews": {
176         "view": false,
177         "edit": false,
178         "remove": false
179       },
180       "assets": {
181         "view": false,
182         "edit": false,
183         "create": false,
184         "remove": false
185       },
186       "products": {
187         "view": false,
188         "edit": false,
189         "create": false,
190         "remove": false,
191         "product": {}
192       },
193       "shippings": {
194         "view": false,
195         "edit": false,
196         "create": false,
197         "remove": false
198       },
199       "warehouses": {
200         "view": false,
201         "edit": false,
202         "create": false,
203         "remove": false,
204         "warehouse": {}
205       },
206       "support": {
207         "view": false,
208         "edit": false,
209         "create": false,
210         "remove": false
211       },
212       "clients": {
213         "view": false,
214         "edit": false,
215         "create": false,
216         "remove": false
217       },
218       "agency_billing_plans": {
219         "view": false,
220         "edit": false,
221         "create": false,
222         "remove": false
223       }
224     }
225   })
226 });
227 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/teammates/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: "John",
16   last_name: "Doe",
17   email: "[email protected]",
18   role: "developer",
19   country: "US",
20   permissions: {
21     account: {
22       view: false,
23       edit: false,
24       remove: false
25     },
26     billing: {
27       view: false,
28       edit: false
29     },
30     keys: {
31       view: false,
32       edit: false,
33       create: false,
34       remove: false
35     },
36     webhooks: {
37       view: false,
38       edit: false,
39       create: false,
40       remove: false
41     },
42     logs: {
43       view: false
44     },
45     audit_trail: {
46       view: false
47     },
48     revenue_analytics: {
49       view: false
50     },
51     source_analytics: {
52       view: false
53     },
54     visitor_analytics: {
55       view: false
56     },
57     domains: {
58       view: false,
59       edit: false,
60       create: false,
61       remove: false
62     },
63     taxes: {
64       view: false,
65       edit: false,
66       create: false,
67       remove: false
68     },
69     teammates: {
70       view: false,
71       edit: false,
72       create: false,
73       remove: false
74     },
75     reports: {
76       view: false,
77       edit: false
78     },
79     sites: {
80       view: false,
81       edit: false,
82       create: false,
83       remove: false,
84       publish: false,
85       site: {}
86     },
87     pages: {
88       view: false,
89       edit: false,
90       create: false,
91       remove: false,
92       page: {}
93     },
94     affiliate_programs: {
95       view: false,
96       edit: false,
97       create: false,
98       remove: false
99     },
100     affiliates: {
101       view: false,
102       edit: false,
103       remove: false
104     },
105     affiliate_network: {
106       view: false,
107       edit: false
108     },
109     payouts: {
110       view: false,
111       edit: false,
112       create: false,
113       remove: false
114     },
115     payments: {
116       view: false,
117       edit: false,
118       remove: false
119     },
120     integrations: {
121       view: false,
122       edit: false,
123       create: false,
124       remove: false,
125       publish: false,
126       integration: {}
127     },
128     invoices: {
129       view: false,
130       edit: false,
131       create: false,
132       remove: false
133     },
134     subscriptions: {
135       view: false,
136       edit: false,
137       remove: false
138     },
139     instalment_plans: {
140       view: false,
141       edit: false,
142       remove: false
143     },
144     customers: {
145       view: false,
146       edit: false,
147       create: false,
148       remove: false,
149       customer: {}
150     },
151     subscribers: {
152       view: false,
153       edit: false,
154       create: false,
155       remove: false
156     },
157     mailing_lists: {
158       view: false,
159       edit: false,
160       create: false,
161       remove: false,
162       mailing_list: {}
163     },
164     automations: {
165       view: false,
166       edit: false,
167       create: false,
168       remove: false
169     },
170     discounts: {
171       view: false,
172       edit: false,
173       create: false,
174       remove: false
175     },
176     email_templates: {
177       view: false,
178       edit: false,
179       create: false,
180       remove: false
181     },
182     reviews: {
183       view: false,
184       edit: false,
185       remove: false
186     },
187     assets: {
188       view: false,
189       edit: false,
190       create: false,
191       remove: false
192     },
193     products: {
194       view: false,
195       edit: false,
196       create: false,
197       remove: false,
198       product: {}
199     },
200     shippings: {
201       view: false,
202       edit: false,
203       create: false,
204       remove: false
205     },
206     warehouses: {
207       view: false,
208       edit: false,
209       create: false,
210       remove: false,
211       warehouse: {}
212     },
213     support: {
214       view: false,
215       edit: false,
216       create: false,
217       remove: false
218     },
219     clients: {
220       view: false,
221       edit: false,
222       create: false,
223       remove: false
224     },
225     agency_billing_plans: {
226       view: false,
227       edit: false,
228       create: false,
229       remove: false
230     }
231   }
232 }.to_json
233 
234 response = https.request(request)
235 puts response.read_body

Responses

{
  "status": 200,
  "teammate": {
    "id": "aaa14567-e89b-12d3-a456-426614174000",
    "object": "teammate",
    "email": "[email protected]",
    "name": "John",
    "last_name": "Doe",
    "country": "US",
    "last_login": 1711929600,
    "role": "developer",
    "verified": true,
    "permissions": {
      "products": {
        "view": true,
        "edit": true,
        "create": true,
        "remove": false
      },
      "invoices": {
        "view": true,
        "edit": false,
        "create": false,
        "remove": false
      }
    }
  }
}

1	const response = await fetch("https://api.tamio.com/v2/teammates/create", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"name": "John",
9	"last_name": "Doe",
10	"email": "[email protected]",
11	"role": "developer",
12	"country": "US",
13	"permissions": {
14	"account": {
15	"view": false,
16	"edit": false,
17	"remove": false
18	},
19	"billing": {
20	"view": false,
21	"edit": false
22	},
23	"keys": {
24	"view": false,
25	"edit": false,
26	"create": false,
27	"remove": false
28	},
29	"webhooks": {
30	"view": false,
31	"edit": false,
32	"create": false,
33	"remove": false
34	},
35	"logs": {
36	"view": false
37	},
38	"audit_trail": {
39	"view": false
40	},
41	"revenue_analytics": {
42	"view": false
43	},
44	"source_analytics": {
45	"view": false
46	},
47	"visitor_analytics": {
48	"view": false
49	},
50	"domains": {
51	"view": false,
52	"edit": false,
53	"create": false,
54	"remove": false
55	},
56	"taxes": {
57	"view": false,
58	"edit": false,
59	"create": false,
60	"remove": false
61	},
62	"teammates": {
63	"view": false,
64	"edit": false,
65	"create": false,
66	"remove": false
67	},
68	"reports": {
69	"view": false,
70	"edit": false
71	},
72	"sites": {
73	"view": false,
74	"edit": false,
75	"create": false,
76	"remove": false,
77	"publish": false,
78	"site": {}
79	},
80	"pages": {
81	"view": false,
82	"edit": false,
83	"create": false,
84	"remove": false,
85	"page": {}
86	},
87	"affiliate_programs": {
88	"view": false,
89	"edit": false,
90	"create": false,
91	"remove": false
92	},
93	"affiliates": {
94	"view": false,
95	"edit": false,
96	"remove": false
97	},
98	"affiliate_network": {
99	"view": false,
100	"edit": false
101	},
102	"payouts": {
103	"view": false,
104	"edit": false,
105	"create": false,
106	"remove": false
107	},
108	"payments": {
109	"view": false,
110	"edit": false,
111	"remove": false
112	},
113	"integrations": {
114	"view": false,
115	"edit": false,
116	"create": false,
117	"remove": false,
118	"publish": false,
119	"integration": {}
120	},
121	"invoices": {
122	"view": false,
123	"edit": false,
124	"create": false,
125	"remove": false
126	},
127	"subscriptions": {
128	"view": false,
129	"edit": false,
130	"remove": false
131	},
132	"instalment_plans": {
133	"view": false,
134	"edit": false,
135	"remove": false
136	},
137	"customers": {
138	"view": false,
139	"edit": false,
140	"create": false,
141	"remove": false,
142	"customer": {}
143	},
144	"subscribers": {
145	"view": false,
146	"edit": false,
147	"create": false,
148	"remove": false
149	},
150	"mailing_lists": {
151	"view": false,
152	"edit": false,
153	"create": false,
154	"remove": false,
155	"mailing_list": {}
156	},
157	"automations": {
158	"view": false,
159	"edit": false,
160	"create": false,
161	"remove": false
162	},
163	"discounts": {
164	"view": false,
165	"edit": false,
166	"create": false,
167	"remove": false
168	},
169	"email_templates": {
170	"view": false,
171	"edit": false,
172	"create": false,
173	"remove": false
174	},
175	"reviews": {
176	"view": false,
177	"edit": false,
178	"remove": false
179	},
180	"assets": {
181	"view": false,
182	"edit": false,
183	"create": false,
184	"remove": false
185	},
186	"products": {
187	"view": false,
188	"edit": false,
189	"create": false,
190	"remove": false,
191	"product": {}
192	},
193	"shippings": {
194	"view": false,
195	"edit": false,
196	"create": false,
197	"remove": false
198	},
199	"warehouses": {
200	"view": false,
201	"edit": false,
202	"create": false,
203	"remove": false,
204	"warehouse": {}
205	},
206	"support": {
207	"view": false,
208	"edit": false,
209	"create": false,
210	"remove": false
211	},
212	"clients": {
213	"view": false,
214	"edit": false,
215	"create": false,
216	"remove": false
217	},
218	"agency_billing_plans": {
219	"view": false,
220	"edit": false,
221	"create": false,
222	"remove": false
223	}
224	}
225	})
226	});
227	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/teammates/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: "John",
16	last_name: "Doe",
17	email: "[email protected]",
18	role: "developer",
19	country: "US",
20	permissions: {
21	account: {
22	view: false,
23	edit: false,
24	remove: false
25	},
26	billing: {
27	view: false,
28	edit: false
29	},
30	keys: {
31	view: false,
32	edit: false,
33	create: false,
34	remove: false
35	},
36	webhooks: {
37	view: false,
38	edit: false,
39	create: false,
40	remove: false
41	},
42	logs: {
43	view: false
44	},
45	audit_trail: {
46	view: false
47	},
48	revenue_analytics: {
49	view: false
50	},
51	source_analytics: {
52	view: false
53	},
54	visitor_analytics: {
55	view: false
56	},
57	domains: {
58	view: false,
59	edit: false,
60	create: false,
61	remove: false
62	},
63	taxes: {
64	view: false,
65	edit: false,
66	create: false,
67	remove: false
68	},
69	teammates: {
70	view: false,
71	edit: false,
72	create: false,
73	remove: false
74	},
75	reports: {
76	view: false,
77	edit: false
78	},
79	sites: {
80	view: false,
81	edit: false,
82	create: false,
83	remove: false,
84	publish: false,
85	site: {}
86	},
87	pages: {
88	view: false,
89	edit: false,
90	create: false,
91	remove: false,
92	page: {}
93	},
94	affiliate_programs: {
95	view: false,
96	edit: false,
97	create: false,
98	remove: false
99	},
100	affiliates: {
101	view: false,
102	edit: false,
103	remove: false
104	},
105	affiliate_network: {
106	view: false,
107	edit: false
108	},
109	payouts: {
110	view: false,
111	edit: false,
112	create: false,
113	remove: false
114	},
115	payments: {
116	view: false,
117	edit: false,
118	remove: false
119	},
120	integrations: {
121	view: false,
122	edit: false,
123	create: false,
124	remove: false,
125	publish: false,
126	integration: {}
127	},
128	invoices: {
129	view: false,
130	edit: false,
131	create: false,
132	remove: false
133	},
134	subscriptions: {
135	view: false,
136	edit: false,
137	remove: false
138	},
139	instalment_plans: {
140	view: false,
141	edit: false,
142	remove: false
143	},
144	customers: {
145	view: false,
146	edit: false,
147	create: false,
148	remove: false,
149	customer: {}
150	},
151	subscribers: {
152	view: false,
153	edit: false,
154	create: false,
155	remove: false
156	},
157	mailing_lists: {
158	view: false,
159	edit: false,
160	create: false,
161	remove: false,
162	mailing_list: {}
163	},
164	automations: {
165	view: false,
166	edit: false,
167	create: false,
168	remove: false
169	},
170	discounts: {
171	view: false,
172	edit: false,
173	create: false,
174	remove: false
175	},
176	email_templates: {
177	view: false,
178	edit: false,
179	create: false,
180	remove: false
181	},
182	reviews: {
183	view: false,
184	edit: false,
185	remove: false
186	},
187	assets: {
188	view: false,
189	edit: false,
190	create: false,
191	remove: false
192	},
193	products: {
194	view: false,
195	edit: false,
196	create: false,
197	remove: false,
198	product: {}
199	},
200	shippings: {
201	view: false,
202	edit: false,
203	create: false,
204	remove: false
205	},
206	warehouses: {
207	view: false,
208	edit: false,
209	create: false,
210	remove: false,
211	warehouse: {}
212	},
213	support: {
214	view: false,
215	edit: false,
216	create: false,
217	remove: false
218	},
219	clients: {
220	view: false,
221	edit: false,
222	create: false,
223	remove: false
224	},
225	agency_billing_plans: {
226	view: false,
227	edit: false,
228	create: false,
229	remove: false
230	}
231	}
232	}.to_json
233
234	response = https.request(request)
235	puts response.read_body