Create Warmup Tag

Create a warmup pool tag.

POSThttps://api.foxreach.io/api/v1/warmup/tags

Requires an API key with the write scope.

Warmup tags group accounts in the warmup pool. They do not change sending.

Body Parameters#

namestringbodyrequired

Tag name. Must be unique in the workspace.

colorstringbody

Optional color, for example #ff0000.

Response#

Returns the tag with a 201 status code.

dataobject

Show data

idstring

Tag identifier.

namestring

Tag name.

colorstring

Tag color.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`400`	`Tag name is required`
`409`	`A tag with that name already exists`

Rate Limit#

120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X POST "https://api.foxreach.io/api/v1/warmup/tags" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Outbound", "color": "#ff0000"}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
tag = client.warmup.create_tag("Outbound", color="#ff0000")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const tag = await client.warmup.createTag({ name: "Outbound", color: "#ff0000" });

Response

JSON

{
  "data": {"id": "tag_abc123", "name": "Outbound", "color": "#ff0000"}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026