Delete Contact
messagebird.delete_contact
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Remove a contact from the address book and from every group it is in.
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
1 field, 1 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 |
|---|---|---|---|---|---|
contact_id The MessageBird id of the contact to remove. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deleted True when MessageBird accepted the deletion. | boolean | — |
id The identifier that was deleted. | string | — |
{
"deleted": false,
"id": ""
}See Delete Contact 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.