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 Mc Segments 2 0 V3
SendGrid Marketing Campaigns Segments 2.0 API is a SendGrid API connector for creating and managing advanced audience segments for email campaigns.
Base URL: https://api.sendgrid.com
Auth: bearer (pass your key via the apiKey input)
Operations
listsegment — GET /v3/marketing/segments/2.0 — Get List of Segments
getsegment — GET /v3/marketing/segments/2.0/{segment_id} — Get Segment by ID
createsegment — POST /v3/marketing/segments/2.0 — Create Segment
refreshsegment — POST /v3/marketing/segments/2.0/refresh/{segment_id} — Manually refresh a segment
Inputs
apiKey — your sendgrid-mc-segments-2-0-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: listsegment
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: listsegment, getsegment, createsegment, deletesegment, updatesegment, refreshsegment
segment_id
string
no
—
Path parameter segment_id (required by some operations).
query
string
no
—
Optional query params as a JSON object string, e.g. {"limit": 10}.
body
string
no
—
Request body as a JSON object string (for create/update operations).