Skip to content
Proud to collaborate with Microsoft for Startups

wasender.groups.remove_participants ​

Remove participants from a group

Remove participants from a group via POST /groups/{groupJid}/participants/remove; requires the session to be a group admin.

Inputs:

  • cloud_connection_uuid: UUID — the cloud connection holding the Wasender token.
  • group_jid: str — group JID (path param groupJid).
  • participants: list — phone/jid strings to remove.

Outputs (terminal state_data):

  • group_jid, participants, results (per-participant outcome list)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-wasender
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidYes—Cloud connection holding the Wasender credential
group_jidstringYes—Group JID (path param groupJid)
participantslistYes—LIST of phone/jid STRINGs to remove

Output Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidNo——
group_jidstringNo——
participantslistNo——
resultslistNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "wasender.groups.remove_participants",
  "initial_data": {
    "cloud_connection_uuid": "value",
    "group_jid": "value",
    "participants": "value"
  }
}