Create Tag

Create an audience tag.

MethodPOST

/api/v2/tags

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.tags.create({ name: "customer" });
if (error) {
  throw error;
}
console.log(data.id, data.name);

Response Examples

{
  "id": "tag_abc123",
  "name": "customer"
}

Creates an audience tag. If the name already exists (case-insensitive), returns the existing tag. Permission: audience.

Body Parameters

Name	Type	Description
`name`	string	Required. Tag name. Min 1, max 100.

Response Fields

Field	Type	Description
`id`	string	Tag id.
`name`	string	Tag name.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `audience` permission
422	`validation_error`	Empty or missing `name`

Get Tag
List Tags
SDK: lumail.tags.create

PreviousList Tags NextGet Tag

Body Parameters

Response Fields

Errors

Related