Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / UpdateTagPayload

Interface: UpdateTagPayload

Defined in: client/src/resources/tags/tags.types.ts:86

Payload for TagsClient.updateById and TagsClient.updateByName.

Both fields are optional — only the fields you include are changed.

Example ​

typescript
// Rename a tag
await client.tags.updateById(tagId, { name: 'VIP Customers' });

// Update description
await client.tags.updateByName('newsletter', { description: 'Monthly newsletter subscribers' });

Properties ​

description? ​

optional description?: string

Defined in: client/src/resources/tags/tags.types.ts:90

New tag description.

name? ​

optional name?: string

Defined in: client/src/resources/tags/tags.types.ts:88

New tag name.