Skip to main content
POST
/
tags
Create Tag
curl --request POST \
  --url https://api.peec.ai/customer/v1/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "color": "gray",
  "group": "persona"
}
'
import requests

url = "https://api.peec.ai/customer/v1/tags"

payload = {
    "name": "<string>",
    "color": "gray",
    "group": "persona"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', color: 'gray', group: 'persona'})
};

fetch('https://api.peec.ai/customer/v1/tags', 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.peec.ai/customer/v1/tags",
  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>',
    'color' => 'gray',
    'group' => 'persona'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.peec.ai/customer/v1/tags"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"color\": \"gray\",\n  \"group\": \"persona\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	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))

}
HttpResponse<String> response = Unirest.post("https://api.peec.ai/customer/v1/tags")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"color\": \"gray\",\n  \"group\": \"persona\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.peec.ai/customer/v1/tags")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"color\": \"gray\",\n  \"group\": \"persona\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "tg_23abec5b-100a-4261-9ee7-1effe68f0149"
}
{
  "message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Body

name
string
required
Minimum string length: 1
color
enum<string>
default:gray
Available options:
gray,
red,
orange,
yellow,
lime,
green,
cyan,
blue,
purple,
fuchsia,
pink,
emerald,
amber,
violet,
indigo,
teal,
sky,
rose,
slate,
zinc,
neutral,
stone
group
string | null

Optional tag group. Tags sharing a group are colored as a unit, so a grouped tag inherits the group's color and the color field is ignored.

Minimum string length: 1
Example:

"persona"

Response

Tag created successfully

Tag created successfully

id
string
required
Example:

"tg_23abec5b-100a-4261-9ee7-1effe68f0149"