Skip to main content

@wildix/xbees-conversations-client > CreateInboxTagCommand

CreateInboxTagCommand class​

Creates a new tag that can be used to group channels. Each user can have up to 15 tags. If the limit is reached, a TagsLimitReachedException will be thrown.

Signature:

export declare class CreateInboxTagCommand extends CreateInboxTagCommand_base

Extends: CreateInboxTagCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { ConversationsClient, CreateInboxTagCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, CreateInboxTagCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // CreateInboxTagInput
  userId: "STRING_VALUE",
  tagId: "STRING_VALUE",
  name: "STRING_VALUE", // required
};
const command = new CreateInboxTagCommand(input);
const response = await client.send(command);
// { // CreateInboxTagOutput
//   tag: { // InboxTag
//     id: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//   },
// };