Remove Contact From Group
messagebird.remove_contact_from_group
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Take one contact out of a group. The contact itself stays in the address book.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- MessageBird
- Secret shape
- the access key, or {"access_key": "…"}
- Config it needs
- originator, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
group_id The MessageBird id of the group to take the contact out of. | string | Yes | — | — | — |
contact_id The MessageBird id of the contact to remove from the group. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
group_id The group the contact was removed from. | string | — |
contact_id The contact that was removed. | string | — |
removed True when MessageBird accepted the change. | boolean | — |
{
"contact_id": "",
"group_id": "",
"removed": false
}See Remove Contact From Group run in a workflow.
In a technical demo we add the MessageBird connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.