lumail.tags.update

SDK 2.1.0 · API v2 · PATCH /api/v2/tags/:tag

MethodPATCH

/api/v2/tags/:tag

Request Examples

import { Lumail } from "lumail";

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

Response Examples

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

[email protected] · lumail.tags

tags.update(idOrName: string, params: { name: string }): Promise<LumailResult<UpdateTagResponse>>

Rename.

Path Parameters

Name	Type	Description
`idOrName`	string	Required. Current tag id or name.

Body Parameters

Name	Type	Description
`name`	string	Required. New tag name.

Response Fields

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

data is { id, name }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.tags.get Nextlumail.events