Create a contact tag
POST
/api/v1/contact-tagsRequest body
namestringrequired
Request
POST
/api/v1/contact-tagscurl -X POST 'https://app.mailyte.com/api/v1/contact-tags' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "<string>"
}'const response = await fetch('https://app.mailyte.com/api/v1/contact-tags', {
method: 'POST',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>"
}),
});
const { data } = await response.json();import requests
response = requests.post(
"https://app.mailyte.com/api/v1/contact-tags",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
json={
"name": "<string>"
},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->post('https://app.mailyte.com/api/v1/contact-tags', [
'name' => '<string>',
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/contact-tags")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
"name": "<string>"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectobjectstringcontact_tagidstringUnique identifier for the tag.
namestringThe label as it was first written. Tags are matched case-insensitively — "VIP" and "vip" are one tag — and the spelling kept is whichever was used first, so a contact never shows two chips for the same label.
contact_countintegerHow many contacts carry this tag. NULL MEANS NOT INCLUDED — this response did not count them — never that the tag is unused. It is present when listing tags and absent when a tag is returned as part of a contact, where counting every tag would cost a query per chip.
created_atstring
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.