Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.
emailmarketing-emailsendgrid
Sendgrid Lmc Contactdb V3
SendGrid Legacy Marketing Campaigns ContactDB API is a SendGrid API connector for managing legacy marketing contacts and recipient lists.
Base URL: https://api.sendgrid.com
Auth: bearer (pass your key via the apiKey input)
Operations
listcustomfield — GET /v3/contactdb/custom_fields — Retrieve all custom fields
getcustomfield — GET /v3/contactdb/custom_fields/{custom_field_id} — Retrieve a Custom Field
listcontactdblist — GET /v3/contactdb/lists — Retrieve all lists
getcontactdblist — GET /v3/contactdb/lists/{list_id} — Retrieve a single list
listrecipientsfromcontactdblist — GET /v3/contactdb/lists/{list_id}/recipients — Retrieve all recipients on a List
listrecipient — GET /v3/contactdb/recipients — Retrieve recipients
Inputs
apiKey — your sendgrid-lmc-contactdb-v3 API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops
Example
operation: listcustomfield
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
error
operation
result
status
Input Properties
Every property this tool accepts, from its own tool.iml.
Property
Type
Required
Default
Description
apiKey
string
yes
—
DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
operation
string
yes
—
One of: listcustomfield, getcustomfield, listcontactdblist, getcontactdblist, listrecipientsfromcontactdblist, listrecipient
custom_field_id
string
no
—
Path parameter custom_field_id (required by some operations).
list_id
string
no
—
Path parameter list_id (required by some operations).
query
string
no
—
Optional query params as a JSON object string, e.g. {"limit": 10}.