Swarmtix Help Center
Tool Reference

swarmtix_speakers_delete

Removes a speaker from an online event and from its talks

swarmtix_speakers_delete

Removes a speaker from an online event and from every talk of that event, and returns how many talks it was taken off. This cannot be undone.

When you would reach for it

  • Removing a speaker who is no longer coming.

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. A second call finds the speaker already unlinked and is refused.

Parameters

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

Example call

{
  "name": "swarmtix_speakers_delete",
  "arguments": {
    "event": "spring-summit-online",
    "speaker": "a41c0000-0000-0000-0000-000000000000"
  }
}

What comes back

{ "deleted": "a41c0000-0000-0000-0000-000000000000", "removedFromTalks": 2 }

What happens when you call it

  1. The event is resolved through the edit gate and must be an online event.
  2. The speaker must be linked to this event.
  3. A published event is refused.
  4. The speaker is unlinked from this event and from this event's talks.
  5. When no other event or talk still uses the speaker, it is switched off (Active set to false) rather than erased, as the dashboard does.

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 speaker cannot be deleted."

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

"speaker is not valid: there is no speaker with that id on this event."

The id is not a speaker of this event. Get the ids from swarmtix_online_program_get.

Use cases

  • Updating a lineup after a cancellation

On this page