Delete Contacts
sendgrid.delete_contacts
ActionEmailconnection required
Calls the SendGrid API with the connection's credentials.
Queue the deletion of marketing contacts by id, or of every contact in the account, and return the job id SendGrid assigns.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- SendGrid
- Secret shape
- {"api_key": "…"}, or the API key on its own
- Config it needs
- from_email, from_name
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none 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 |
|---|---|---|---|---|---|
ids Contact ids to delete, separated by commas. | string | No | — | — | — |
delete_all Delete every contact in the account instead of the listed ids. | boolean | No | false | — | — |
- At least one of ids, delete_all must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"delete_all": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
job_id The asynchronous deletion job SendGrid queued. | string | — |
queued Always true: the delete is queued, not yet applied. | boolean | — |
delete_all Whether the whole account was targeted. | boolean | — |
{
"delete_all": false,
"job_id": "",
"queued": false
}Notes
- SendGrid processes contact writes asynchronously: the call answers with a job_id and the contacts are queued, not yet stored. Poll SendGrid's import job status endpoint if you need to know the job finished.
Templates that use SendGrid
See Delete Contacts run in a workflow.
In a technical demo we add the SendGrid connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.