Skip to content

SDK method

tools.removeSubscriber

Unsubscribe. Convenience alias for remove_subscriber, forwarding to tinbox.api.members.archive.mutate.

Signature

ts
removeSubscriber(input: Parameters<TinboxTools["removeSubscriber"]>[0]): ReturnType<TinboxTools["removeSubscriber"]>

Parameters

NameTypeRequiredDescription
idstringyesThe member id (from list_subscribers).

Returns

ReturnType<TinboxTools["removeSubscriber"]>

Example

ts
await tinbox.tools.removeSubscriber({
  "id": "<id>"
});