Agency API Clients

Bulk delete clients

POST https://api.tamio.com/v2/clients/bulk/delete

Deletes multiple client accounts in a single request.

Body Parameters

clients array of string*

Array of client UUIDs to delete

Example

{
  "clients": [
    "550e8400-e29b-41d4-a716-446655440001",
    "550e8400-e29b-41d4-a716-446655440002",
    "550e8400-e29b-41d4-a716-446655440003"
  ]
}

Responses

200 All clients deleted successfully

All clients deleted successfully

status integer

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1002`	One or more client UUIDs not found or belong to another agency
`10293`	One or more clients have an active subscription and cannot be deleted

status integer

error string

error_code integer

401 Unauthorized – invalid or missing Bearer token

Delete a client

/clients/bulk/delete

1 const response = await fetch("https://api.tamio.com/v2/clients/bulk/delete", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "clients": [
9       "550e8400-e29b-41d4-a716-446655440001",
10       "550e8400-e29b-41d4-a716-446655440002",
11       "550e8400-e29b-41d4-a716-446655440003"
12     ]
13   })
14 });
15 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/bulk/delete")
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   clients: ["550e8400-e29b-41d4-a716-446655440001", "550e8400-e29b-41d4-a716-446655440002", "550e8400-e29b-41d4-a716-446655440003"]
16 }.to_json
17 
18 response = https.request(request)
19 puts response.read_body

Responses

{
  "status": 200
}

1	const response = await fetch("https://api.tamio.com/v2/clients/bulk/delete", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"clients": [
9	"550e8400-e29b-41d4-a716-446655440001",
10	"550e8400-e29b-41d4-a716-446655440002",
11	"550e8400-e29b-41d4-a716-446655440003"
12	]
13	})
14	});
15	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/bulk/delete")
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	clients: ["550e8400-e29b-41d4-a716-446655440001", "550e8400-e29b-41d4-a716-446655440002", "550e8400-e29b-41d4-a716-446655440003"]
16	}.to_json
17
18	response = https.request(request)
19	puts response.read_body