Swarmtix Help Center
Tool Reference

swarmtix_hosts_delete

Deletes a host that has not connected Zoom and is not used by a talk

swarmtix_hosts_delete

Deletes a host of an online event. This cannot be undone.

When you would reach for it

  • Removing a host that is not needed, which also clears a ConnectWebinarProvider blocker.

Scope

events:write

The connection's user must be allowed to edit the event, and the event must be an online event.

The event must be unpublished.

This tool is marked destructive and is not idempotent.

Parameters

NameTypeRequiredDefaultDescription
eventstringYes-The event's id (a GUID) or its URL slug.
hoststringYes-The id of the host, as returned by swarmtix_online_program_get.

Example call

{
  "name": "swarmtix_hosts_delete",
  "arguments": {
    "event": "spring-summit-online",
    "host": "c9d20000-0000-0000-0000-000000000000"
  }
}

What comes back

The id of the deleted host.

What happens when you call it

  1. The event is resolved through the edit gate and must be an online event.
  2. A published event is refused.
  3. The host must belong to this event.
  4. The call is refused when a talk uses the host, when the host has connected Zoom, or when the host has webinar provider rows.
  5. Otherwise the host is deleted.

Troubleshooting

"Event not found, or this connection does not have access to it."

The event does not exist, it belongs to another organisation, or this organizer may read it but not edit it.

"This event is not an online event. Talks, speakers, categories and hosts belong to online events only. Nothing was changed."

The event is a physical event. These tools only work on events created with kind: "online".

"event is not valid: it is published, so a host cannot be deleted."

Deleting is refused while the event is published. Unpublish it first with swarmtix_events_unpublish, then try again.

The host is refused because it is connected or in use

A host that has connected Zoom, or that a talk uses, is removed in the Swarmtix dashboard. Connected hosts hold Zoom tokens, which a tool does not touch.

Use cases

  • Removing a host that was added by mistake

On this page