Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / TagDetail

Interface: TagDetail

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

A tag with an optional subscriber count.

Returned by TagsClient.getById and TagsClient.getByName when withCount: true is requested.

Extends ​

Properties ​

createdAt? ​

optional createdAt?: string

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

ISO 8601 timestamp of when the tag was created.

Present in list responses. Absent in single-tag responses.

Inherited from ​

Tag.createdAt

description? ​

optional description?: string

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

Optional tag description.

Inherited from ​

Tag.description

id ​

id: number

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

Tag ID.

Inherited from ​

Tag.id

name ​

name: string

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

Tag name.

Inherited from ​

Tag.name

recipientCount? ​

optional recipientCount?: number

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

Number of subscribers currently associated with this tag.

Only present when the method was called with withCount: true.

updatedAt? ​

optional updatedAt?: string

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

ISO 8601 timestamp of when the tag was last updated.

Present in list responses. Absent in single-tag responses.

Inherited from ​

Tag.updatedAt