Agents
Add tags to an agent
Attaches one or more tags to the specified agent in batch.
Notes:
- tagNames must not be empty; up to 20 entries per call.
- When autoCreate is true, tag names not yet defined on the team are created; when false, unknown tag names cause the call to fail.
- The response envelope carries data = true and errorCode = 0 on success.
POST
/
v1.0
/
agent
/
{agentId}
/
tag
/
add
Add tags to an agent
curl --request POST \
--url https://api.lofty.com/v1.0/agent/{agentId}/tag/add \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"tagNames": [
"VIP",
"Premium"
],
"autoCreate": true
}
'import requests
url = "https://api.lofty.com/v1.0/agent/{agentId}/tag/add"
payload = {
"tagNames": ["VIP", "Premium"],
"autoCreate": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
body: JSON.stringify({tagNames: ['VIP', 'Premium'], autoCreate: true})
};
fetch('https://api.lofty.com/v1.0/agent/{agentId}/tag/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lofty.com/v1.0/agent/{agentId}/tag/add",
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([
'tagNames' => [
'VIP',
'Premium'
],
'autoCreate' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lofty.com/v1.0/agent/{agentId}/tag/add"
payload := strings.NewReader("{\n \"tagNames\": [\n \"VIP\",\n \"Premium\"\n ],\n \"autoCreate\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.lofty.com/v1.0/agent/{agentId}/tag/add")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"tagNames\": [\n \"VIP\",\n \"Premium\"\n ],\n \"autoCreate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lofty.com/v1.0/agent/{agentId}/tag/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"tagNames\": [\n \"VIP\",\n \"Premium\"\n ],\n \"autoCreate\": true\n}"
response = http.request(request)
puts response.read_body{
"data": true,
"errorCode": 0,
"errorMsg": "<string>"
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}Path Parameters
User ID of the agent to tag.
Required range:
x >= 1Body
application/json
Response
Envelope indicating whether the batch add succeeded.
Response for POST /v1.0/agent/{agentId}/tag/add. Envelope that carries the batch result and an error code when the operation fails.
⌘I
Add tags to an agent
curl --request POST \
--url https://api.lofty.com/v1.0/agent/{agentId}/tag/add \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"tagNames": [
"VIP",
"Premium"
],
"autoCreate": true
}
'import requests
url = "https://api.lofty.com/v1.0/agent/{agentId}/tag/add"
payload = {
"tagNames": ["VIP", "Premium"],
"autoCreate": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
body: JSON.stringify({tagNames: ['VIP', 'Premium'], autoCreate: true})
};
fetch('https://api.lofty.com/v1.0/agent/{agentId}/tag/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lofty.com/v1.0/agent/{agentId}/tag/add",
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([
'tagNames' => [
'VIP',
'Premium'
],
'autoCreate' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lofty.com/v1.0/agent/{agentId}/tag/add"
payload := strings.NewReader("{\n \"tagNames\": [\n \"VIP\",\n \"Premium\"\n ],\n \"autoCreate\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.lofty.com/v1.0/agent/{agentId}/tag/add")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"tagNames\": [\n \"VIP\",\n \"Premium\"\n ],\n \"autoCreate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lofty.com/v1.0/agent/{agentId}/tag/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"tagNames\": [\n \"VIP\",\n \"Premium\"\n ],\n \"autoCreate\": true\n}"
response = http.request(request)
puts response.read_body{
"data": true,
"errorCode": 0,
"errorMsg": "<string>"
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}{
"data": true,
"errorCode": 123,
"errorMsg": "<string>",
"errorData": {}
}